Overview
The loc:path-to-root resource represents the folder path that leads to a location item, from the root folder to the direct parent folder of the item. It can be used to track breadcrumbs of a folder. loc:path-to-root contains an array of loc:path links, pointing to the folder items (resource type loc:item) that make up the path. The array lists the folder items from the root (index 0) to the next enclosing parent (index n).
Properties
The loc:path-to-root resource has no properties.
Link Relations
Get the location item that the path refers to. |
|
Get the location items (resource type loc:item) that make up the path. |
Examples
Example of the loc:path-to-root resource
{
"_links": {
"curies": [
{
"href": "https://developer.avid.com/ctms/api/loc/linkrels/{rel}.html",
"name": "loc",
"templated": true
}
],
"self": {
"href": "https://host/…"
},
"loc:path": [
{
"href": "https://host/…",
"title": "Root"
},
{
"href": "https://host/…",
"title": "Common folders"
}
],
"loc:item": {
"href": "https://host/…"
}
}
}
Example of the loc:path-to-root resource with embedded path, when called with the query parameter embed=path
{
"_links": {
"curies": [
{
"href": "https://developer.avid.com/ctms/api/loc/linkrels/{rel}.html",
"name": "loc",
"templated": true
}
],
"self": {
"href": "https://host/…"
},
"loc:path": [
{
"href": "https://host/…",
"title": "Root"
},
{
"href": "https://host/…",
"title": "Common folders"
}
],
"loc:item": {
"href": "https://host/…"
}
},
"_embedded": {
"loc:path": [
{
"base": {
"id": "1",
"type": "folder",
"systemType": "interplay-mam",
"systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
},
"common": {
"name": "Root",
"creator": "SYSTEM",
"created": "2017-02-14T10:14:08.533+01:00",
"modifier": "admin",
"modified": "2017-08-02T14:12:09.837+02:00"
},
"_links": {
"self": {
"href": "https://host/…"
},
"loc:collection": {
"href": "https://host/…"
},
"profile": {
"href": "https://host/…"
},
"loc:update-item": {
"href": "https://host/…"
},
"loc:path-to-root": {
"href": "https://host/…"
},
"loc:add-item": {
"href": "https://host/…"
},
"loc:add-items": {
"href": "https://host/…"
},
"loc:move-item": {
"href": "https://host/…"
},
"loc:move-items": {
"href": "https://host/…"
}
}
},
{
"base": {
"id": "3",
"type": "folder",
"systemType": "interplay-mam",
"systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
},
"common": {
"name": "Common folders",
"creator": "admin",
"created": "2017-02-14T10:34:59.243+01:00",
"modifier": "admin",
"modified": "2017-02-14T10:34:59.243+01:00"
},
"_links": {
"self": {
"href": "https://host/…"
},
"loc:collection": {
"href": "https://host/…"
},
"profile": {
"href": "https://host/…"
},
"loc:update-item": {
"href": "https://host/…"
},
"loc:path-to-root": {
"href": "https://host/…"
},
"loc:add-item": {
"href": "https://host/…"
},
"loc:add-items": {
"href": "https://host/…"
},
"loc:move-item": {
"href": "https://host/…"
},
"loc:move-items": {
"href": "https://host/…"
}
}
}
]
}
}
Example of the loc:path-to-root resource in MediaCentral Production Management
{
"_links": {
"self": {
"href": "https://host/…"
},
"loc:path": {
"href": "https://host/…",
"title": "AvidWG"
},
"loc:item": {
"href": "https://host/…"
}
}
}