# COLLECTIONS

Invoke the Collection API to create, retrieve, edit, and delete Collections.  Collections are used to group and catalog related Assets for quick access and consumption.  Collections can be configured as:
  - private: Visible only to the user who created the Collection.
  - secured: Visible to users with.

When retrieving the Assets within a Collection, the requesting user will only see the Assets that the user has access to view.  For example, a librarian may see all Assets within a Collection, but a general consumer user may only see a portion of those Assets, due to limited security access.

## Create Collection

 - [POST /collection](https://api.tenovos.com/openapi/v1.5/collections/createcollection.md): Create a collection and add assets to it. Assets in the collection are identified by FileID therefore collectionDocument contains File ID

The user should have View permission on assets to be added to the collection.

Average Response Time: 200ms (Private Collection)

Average Response Time: 2568ms (Shared Collection)

## Get Collection

 - [GET /collection/{id}](https://api.tenovos.com/openapi/v1.5/collections/getcollection.md): Retrieve a single Collection specified by Collection ID.  The retrieved Collection may be either a secured Collection or a private Collection created by the User.  The Collection will include the list of Assets assigned to the Collection, referenced by Asset File ID.

The User retrieving the Collection must have the Collection Security Role Privilege.

Average Response Time: 53ms

## Delete Collection

 - [DELETE /collection/{id}](https://api.tenovos.com/openapi/v1.5/collections/deletecollection.md): User can delete the collection, but the Assets assigned to the Collection will remain and dissociate from this Collection.

The User submitting the request to delete a private Collection must have the Collection and Delete Security Role Privilege.  Secured Collections may only be deleted by Users with the Purge Security Role Privilege.

Average Response Time: 81ms

## Update Collection

 - [PATCH /collection/{id}](https://api.tenovos.com/openapi/v1.5/collections/updatecollection.md): Update a Collection's attributes or assigned Assets. The list of existing assets is replaced with assets provided in the call. Assets in the collection are referenced by Asset FileID therefore the collectionDocument must contain asset's FileID.

The User editing the Collection must have the Collection Security Role Privilege.  The User must have View access to the Assets that are being added to or removed from the Collection.

Average Response Time: 5070ms

## Share Collection Contents

 - [POST /collection/{id}/share](https://api.tenovos.com/openapi/v1.5/collections/sharecollection.md): Share the zip file of all accessible Assets in a collection and send to the specified emails in share users list. User can also send the custom share message along with request. \n\nThe user sharing the Assets must be granted the Download and Share Security Template permission on the Assets being shared.

Average Response Time: 49ms