createCollectionOnResource method

Future<DynamiteResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>> createCollectionOnResource({
  1. required String name,
  2. required String baseResourceType,
  3. required String baseResourceId,
  4. 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:

Implementation

Future<DynamiteResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>>
    createCollectionOnResource({
  required String name,
  required String baseResourceType,
  required String baseResourceId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = createCollectionOnResourceRaw(
    name: name,
    baseResourceType: baseResourceType,
    baseResourceId: baseResourceId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}