Overview
The loc:collection resource represents the list of items contained in a folder
Properties
The loc:collection resource has the following properties:
paging |
Paging information. See paging for details. |
---|
Link Relations
prev, next, first |
Link relations for paging. See paging for details. |
---|---|
Get the location items in the collection. |
Description
The loc:collection resource represents the list of items contained in a folder
A location collection supports paging. See Paging information for details on the paging properties and the paging link rels.
Examples
A location collection in MediaCentral | Production Management
{
"base": {
"systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
"systemType": "interplay-pam",
"id": "/",
"type": "folder"
},
"common": {
"creator": "Administrator",
"created": "2015-04-17T15:57:56.719Z",
"name": "AvidWG",
"modified": "2016-05-30T16:27:31.139Z"
},
"_links": {
"self": {
"href": "https://host/…"
},
"loc:collection": {
"href": "https://host/…"
},
"loc:locations": {
"href": "https://host/…"
},
"loc:create-folder": {
"href": "https://host/…"
},
"loc:update-item": {
"href": "https://host/…"
},
"loc:add-item": {
"href": "https://host/…"
},
"loc:move-item": {
"href": "https://host/…"
},
"loc:add-items": {
"href": "https://host/…"
},
"loc:move-items": {
"href": "https://host/…"
},
"loc:path-to-root": {
"href": "https://host/…"
},
"curies": [
{
"name": "loc",
"href": "https://developer.avid.com/ctms/api/loc/linkrels/{rel}.html",
"templated": true
},
{
"name": "aa",
"href": "https://developer.avid.com/ctms/api/aa/linkrels/{rel}.html",
"templated": true
},
{
"name": "pa",
"href": "https://developer.avid.com/ctms/api/pa/linkrels/{rel}.html",
"templated": true
}
]
},
"_embedded": {
"loc:collection": {
"paging": {
"limit": 25,
"offset": 0,
"elements": 11,
"totalElements": 11
},
"_links": {
"self": {
"href": "https://host/…"
},
"first": {
"href": "https://host/…"
},
"loc:locations": {
"href": "https://host/…"
},
"loc:item": [
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
},
{
"href": "https://host/…"
}
]
},
"_embedded": {
"loc:item": [
{
"base": {
"systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
"systemType": "interplay-pam",
"id": "/Projects/",
"type": "project"
},
"common": {
"creator": "Administrator",
"created": "2015-04-17T15:57:58.141Z",
"modifier": "Administrator",
"name": "Projects",
"modified": "2015-04-17T15:57:58.141Z"
},
"_links": {
"self": {
"href": "https://host/…"
},
"loc:collection": {
"href": "https://host/…"
},
"loc:locations": {
"href": "https://host/…"
},
"loc:create-folder": {
"href": "https://host/…"
},
"loc:update-item": {
"href": "https://host/…"
},
"loc:add-item": {
"href": "https://host/…"
},
"loc:move-item": {
"href": "https://host/…"
},
"loc:add-items": {
"href": "https://host/…"
},
"loc:move-items": {
"href": "https://host/…"
},
"loc:path-to-root": {
"href": "https://host/…"
}
}
},
{
"base": {
"systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
"systemType": "interplay-pam",
"id": "/Catalogs/",
"type": "catalog"
},
"common": {
"creator": "Administrator",
"created": "2015-04-17T15:57:58.172Z",
"modifier": "Administrator",
"name": "Catalogs",
"modified": "2015-04-17T15:57:58.172Z"
},
"_links": {
"self": {
"href": "https://host/…"
},
"loc:collection": {
"href": "https://host/…"
},
"loc:locations": {
"href": "https://host/…"
},
"loc:create-folder": {
"href": "https://host/…"
},
"loc:update-item": {
"href": "https://host/…"
},
"loc:add-item": {
"href": "https://host/…"
},
"loc:move-item": {
"href": "https://host/…"
},
"loc:add-items": {
"href": "https://host/…"
},
"loc:move-items": {
"href": "https://host/…"
},
"loc:path-to-root": {
"href": "https://host/…"
}
}
}
… // Skipping remaining items
]
}
}
}
}