$createCollectionOnResource_Request method

@experimental Request $createCollectionOnResource_Request({ required String name, required String baseResourceType, required String baseResourceId, bool? oCSAPIRequest, })

Create a collection for a resource.

Returns a DynamiteRequest backing the createCollectionOnResource operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• name Name of the collection.
• baseResourceType Type of the base resource.
• baseResourceId ID of the base resource.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Collection returned
• 400: Creating collection is not possible
• 404: Resource inaccessible
• 500

See:

• createCollectionOnResource for a method executing this request and parsing the response.
• $createCollectionOnResource_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $createCollectionOnResource_Request({
  required String name,
  required String baseResourceType,
  required String baseResourceId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $name = _$jsonSerializers.serialize(name, specifiedType: const FullType(String));
  _parameters['name'] = $name;

  final $baseResourceType = _$jsonSerializers.serialize(baseResourceType, specifiedType: const FullType(String));
  _parameters['baseResourceType'] = $baseResourceType;

  final $baseResourceId = _$jsonSerializers.serialize(baseResourceId, specifiedType: const FullType(String));
  _parameters['baseResourceId'] = $baseResourceId;

  final _path = _i5.UriTemplate('/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}{?name*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _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 _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}