listCollection method

Future<DynamiteResponse<CollaborationResourcesListCollectionResponseApplicationJson, void>> listCollection({
  1. required int collectionId,
  2. bool? oCSAPIRequest,
})

Get 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:

  • 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<_i1.DynamiteResponse<CollaborationResourcesListCollectionResponseApplicationJson, void>> listCollection({
  required int collectionId,
  bool? oCSAPIRequest,
}) async {
  final _request = $listCollection_Request(
    collectionId: collectionId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $listCollection_Serializer();
  return _i1.ResponseConverter<CollaborationResourcesListCollectionResponseApplicationJson, void>(_serializer)
      .convert(_response);
}