Create a Collection.

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.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object.

collectionType
string
Enum: "secured" "private"
name
string

Name of the collection

collectionDocument
Array of strings <uuid>

List of Asset IDs to be added to the Collection.

metadataTemplateId
string <uuid>

Unique ID of the metadata template for 'secure' or 'private' collections

securityTemplateIds
Array of strings <uuid>

List of Security Template IDs

Array of MetadataStringValue (object) or MetadataRestrictedVocabularyValue (object) or MetadataDateValue (object) or MetadataMultiValue (object) or MetadataGridValue (object)

Array of metadata attributes that are required for the metadata template

Responses
200

Successful operation

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden.

post/collection
Request samples
application/json
{
  • "collectionType": "secured",
  • "name": "Best of the month",
  • "collectionDocument": [
    ],
  • "metadataTemplateId": "ea6eb24d-adef-4380-bd02-f64f567c437f",
  • "securityTemplateIds": [
    ],
  • "MetadataDocument": [
    ]
}
Response samples
application/json
{
  • "statusCode": "success",
  • "message": "Collection successfully created",
  • "collectionId": "4b5896b4-33e4-41ac-b251-39a4dbaa25b1"
}