$listTeams_Request method
- @experimental
Get all teams of a resource.
Returns a DynamiteRequest
backing the listTeams operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
providerId
Identifier of the provider (e.g. deck, talk, collectives).resourceId
Unique id of the resource to list teams for (e.g. deck board id).oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Teams returned
See:
- listTeams for a method executing this request and parsing the response.
- $listTeams_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $listTeams_Request({
required String providerId,
required String resourceId,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final __providerId = _$jsonSerializers.serialize(providerId, specifiedType: const FullType(String));
_parameters['providerId'] = __providerId;
final __resourceId = _$jsonSerializers.serialize(resourceId, specifiedType: const FullType(String));
_parameters['resourceId'] = __resourceId;
final _path = _i6.UriTemplate('/ocs/v2.php/teams/resources/{providerId}/{resourceId}').expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('get', _uri);
_request.headers['Accept'] = 'application/json';
// coverage:ignore-start
final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_request.headers.addAll(
authentication.headers,
);
} else {
throw Exception('Missing authentication for bearer_auth or basic_auth');
}
// coverage:ignore-end
var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
__oCSAPIRequest ??= true;
_request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert(__oCSAPIRequest);
return _request;
}