Get Collection

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

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify Collection ID

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"
Responses
200

The Response Body is a JSON object describing the collection.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

response contains detailed error message.

get/collection/{id}
Request samples 
Response samples 
application/json
{
  • "expirationDate": 1613755131855,
  • "lastUpdatedEpoch": 1613755131855,
  • "shareMessage": "",
  • "recipients": [
    ],
  • "downloadId": "NULL",
  • "shared": "N",
  • "name": "Best of the month",
  • "shareDocument": [
    ],
  • "sender": { },
  • "createdEpoch": 1613755131855,
  • "userCognitoId": "7d675ef0-f423-11e9-8071-89c0c4052141",
  • "collectionType": "secured",
  • "collectionId": "4dc328ce-4b3f-4f76-b7bb-1e83ad35458a",
  • "collectionDocument": [
    ],
  • "customerId": "1235644566523"
}