renameCollection method

Future<DynamiteResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void>> renameCollection({
  1. required String collectionName,
  2. required int collectionId,
  3. bool? oCSAPIRequest,
})

Rename a collection.

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:

  • collectionName New name.
  • collectionId ID of the collection.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Collection returned
  • 404: Collection not found
  • 500

See:

Implementation

Future<DynamiteResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void>> renameCollection({
  required String collectionName,
  required int collectionId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = renameCollectionRaw(
    collectionName: collectionName,
    collectionId: collectionId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}