$getGroupsDetails_Request method
- @experimental
Get a list of groups details.
Returns a DynamiteRequest
backing the getGroupsDetails operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
search
Text to search for. Defaults to""
.limit
Limit the amount of groups returned.offset
Offset for searching for groups. Defaults to0
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Groups details returned
See:
- getGroupsDetails for a method executing this request and parsing the response.
- $getGroupsDetails_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getGroupsDetails_Request({
String? search,
int? limit,
int? offset,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
var __search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
__search ??= '';
_parameters['search'] = __search;
final __limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
_parameters['limit'] = __limit;
var __offset = _$jsonSerializers.serialize(offset, specifiedType: const FullType(int));
__offset ??= 0;
_parameters['offset'] = __offset;
final _path = _i6.UriTemplate('/ocs/v2.php/cloud/groups/details{?search*,limit*,offset*}').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;
}