createCollectionOnResource method

Future<DynamiteResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>> createCollectionOnResource({ required String name, required String baseResourceType, required String baseResourceId, bool? oCSAPIRequest, })

Create a collection for a resource.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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_Request for the request send by this method.
• $createCollectionOnResource_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>>
    createCollectionOnResource({
  required String name,
  required String baseResourceType,
  required String baseResourceId,
  bool? oCSAPIRequest,
}) async {
  final _request = $createCollectionOnResource_Request(
    name: name,
    baseResourceType: baseResourceType,
    baseResourceId: baseResourceId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $createCollectionOnResource_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>(
    _serializer,
  ).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}