Named groups for organising assets.
GET /api/v1/collections/
List collections.
Response
Response 200 (application/json)
{
"collections": [
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
]
}
POST /api/v1/collections/
Create a collection.
Request
Request body (application/json)
{
"name": "string",
"description": "string",
"tags": [
"string"
],
"custom": {}
}
Response
Response 201 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
GET /api/v1/collections/{id}
Get a collection.
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"assets": [
{}
],
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
PATCH /api/v1/collections/{id}
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
Request
Request body (application/json)
{
"description": "string",
"tags": [
"string"
],
"custom": {}
}
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
PUT /api/v1/collections/{id}/assets/{assetId}
Add an asset to a collection.
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
assetId | path | string | required |
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
DELETE /api/v1/collections/{id}/assets/{assetId}
Remove an asset from a collection.
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
assetId | path | string | required |
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
PUT /api/v1/collections/{id}/lock
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
Request
Request body (application/json)
{
"reason": "string",
"lockedBy": "string"
}
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}
DELETE /api/v1/collections/{id}/lock
Parameters
| Name | In | Type | Required |
|---|
id | path | string | required |
Response
Response 200 (application/json)
{
"id": "string",
"name": "string",
"assetIds": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"description": "string",
"tags": [
"string"
],
"custom": {},
"deleteLock": {
"locked": true,
"lockedAt": "string",
"reason": "string",
"lockedBy": "string"
}
}