Resource loc:item

Overview

The loc:item resource represents a single node the folder tree of a system.

Properties

The loc:item resource has the following properties:

base	Base identifiers of the item. The property is a JSON object with the following sub properties: systemType systemID type id
common	Common attributes: name creator created modifier modified dropframe (optional) editRate See Common Object Properties for details. MediaCentral Production Management: dropframe: the value is inferred by analysis of the common attribute "startTC" editRate: the property will not be present, if the asset has no valid editrate
attributes	An array containing one element per attribute. If a specific requested attribute is unknown, it (the complete element) will be left away in the response’s "attributes" array, i.e. not null, not "", not [], not {}, not false, not 0, the element is just not existing. MediaCentral Asset Management: Attribute names are case insensitive. Each element of "attributes" is an object with two properties, "name" and "value", whose purposes should be clear. However, "name"'s content will correspond to the respective name specified in the request’s attribute list. MediaCentral Production Management: Attribute names are case insensitive. Each element of "attributes" is an object with "name", "value" and "group", where group is an attribute type of "User" or "System" attribute. MediaCentral Asset Management: attribute example `"attributes": [ { "name": "comment", "value": "A comment" } ]` MediaCentral Production Management: attribute example `"attributes": [ { "name": "com.avid.workgroup.Property.System.Format", "value": "HD 1080i/50", "type": "string", "value-labels": { "en": "HD 1080i/50" } }, ]`
status	Status information for the item. See Status of an aa:asset or loc:item for details.

base

Base identifiers of the item. The property is a JSON object with the following sub properties:

systemType
systemID
type
id

common

Common attributes:

name
creator
created
modifier
modified
dropframe
(optional) editRate

See Common Object Properties for details.

MediaCentral Production Management:

dropframe: the value is inferred by analysis of the common attribute "startTC"
editRate: the property will not be present, if the asset has no valid editrate

attributes

An array containing one element per attribute.

If a specific requested attribute is unknown, it (the complete element) will be left away in the response’s "attributes" array, i.e. not null, not "", not [], not {}, not false, not 0, the element is just not existing.

MediaCentral Asset Management:

Attribute names are case insensitive.
Each element of "attributes" is an object with two properties, "name" and "value", whose purposes should be clear. However, "name"'s content will correspond to the respective name specified in the request’s attribute list.

MediaCentral Production Management:

Attribute names are case insensitive.
Each element of "attributes" is an object with "name", "value" and "group", where group is an attribute type of "User" or "System" attribute.

MediaCentral Asset Management: attribute example

"attributes": [
    { "name": "comment", "value": "A comment" }
  ]

MediaCentral Production Management: attribute example

"attributes": [
        {
            "name": "com.avid.workgroup.Property.System.Format",
            "value": "HD 1080i/50",
            "type": "string",
            "value-labels": {
                "en": "HD 1080i/50"
            }
        },
      ]

status

Status information for the item. See Status of an aa:asset or loc:item for details.

Link Relations

Common Link Relations
loc:update-item	Update a location item.
loc:parent-collection	Get the parent collection at the position of the current item.
loc:parent-folder	Get the loc:item resource of the parent folder.
loc:path-to-root	Get the parent items of this location item.

Common Link Relations

loc:update-item

Update a location item.

loc:parent-collection

Get the parent collection at the position of the current item.

loc:parent-folder

Get the loc:item resource of the parent folder.

loc:path-to-root

Get the parent items of this location item.

Link Relations for Folders
loc:collection	Get the child items of this location item.
loc:collection-at-itemid	Get the child items of this location item.
loc:add-item	Add a single location item to the folder item.
loc:add-items	Add multiple location items to the folder item.
loc:create-folder	Add a new folder to the folder item.
loc:move-item	Move a single location item to the folder item.
loc:move-items	Move multiple location items to the folder item.
loc:delete-item	Delete an item. This link relation is only available for MC \| AM and for folders of MC \| PM.
loc:delete-item-by-id	Delete a location item from the folder item. This link relation is only available for MC \| AM.
loc:delete-item-in-folder-by-id-bulk-command	Delete a list of location items from the folder.

Link Relations for Folders

loc:collection

Get the child items of this location item.

loc:collection-at-itemid

Get the child items of this location item.

loc:add-item

Add a single location item to the folder item.

loc:add-items

Add multiple location items to the folder item.

loc:create-folder

Add a new folder to the folder item.

loc:move-item

Move a single location item to the folder item.

loc:move-items

Move multiple location items to the folder item.

loc:delete-item

Delete an item. This link relation is only available for MC | AM and for folders of MC | PM.

loc:delete-item-by-id

Delete a location item from the folder item. This link relation is only available for MC | AM.

loc:delete-item-in-folder-by-id-bulk-command

Delete a list of location items from the folder.

Link Relations For Non-Folder Items
loc:referenced-object	Get the asset that is referenced by this location item.

Link Relations For Non-Folder Items

loc:referenced-object

Get the asset that is referenced by this location item.

Description

The loc:item resource represents a single node the folder tree of a system.

A location item is an item used in a tree representation of a system. An item can be:

a folder.
a reference to an asset.
both.

A location item is a common object, meaning that it has the common properties of a common object. See Common Object Properties for details.

Additionally, it can have the property attributes, which represents attributes, which can be requested additionally.

Examples

MediaCentral Asset Management: a location item that acts as an asset reference

 
{
  "base": {
        "id": "101",
        "type": "folder",
		"systemType": "interplay-mam",
        "systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
  },
  "common": {
        "name": "Test folder",
		"creator": "admin",
        "created": "2017-02-14T14:44:45.61+01:00",
		"modifier": "admin",
        "modified": "2017-02-14T14:44:45.633+01:00"
  },
  "_links": {
    "curies": [
      {
        "href": "http://services.avid.com/apis/mam/assets/{rel}",
        "name": "ma",
        "templated": true
      },
      {
        "href": "http://services.avid.com/apis/assets/{rel}",
        "name": "aa",
        "templated": true
      },
      {
        "href": "http://services.avid.com/apis/locations/{rel}",
        "name": "loc",
        "templated": true
      }
        ], "self": {
            "href": "https://host/…"
        },
        "loc:collection": {
            "href": "https://host/…"
        },
        "profile": {
            "href": "https://host/…"
        },
        "loc:update-item": {
            "href": "https://host/…"
        },
        "loc:path": {
            "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/…"
        },
        "loc:delete-item-by-id": {
            "href": "https://host/…",
            "templated": true
        }
    },
    "_embedded": {
        "loc:collection": {
            "paging": {
                "elements": 2,
                "totalElements": 2,
                "limit": 100,
                "offset": 0
            },
            "_links": {
                "self": {
                    "href": "https://host/…"
                },
                "loc:collection": {
                    "href": "https://host/…",
                    "templated": true
                },
                "first": {
                    "href": "https://host/…"
                },
                "range": {
                    "href": "https://host/…",
                    "templated": true
                },
                "loc:item": [
                    {
                        "href": "https://host/…"
                    },
                    {
                        "href": "https://host/…"
                    }
                ]
            },
            "_embedded": {
                "loc:item": [
                    {
                        "base": {
                            "id": "100.102",
                            "type": "folder-item",
                            "systemType": "interplay-mam",
                            "systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
                        },
                        "common": {
                            "name": "Bear MPG",
                            "creator": "admin",
                            "created": "2017-02-14T15:27:49.56+01:00",
                            "modifier": "admin",
                            "modified": "2017-02-14T15:27:49.56+01:00",
                            "typeIcon": "https://host/…",
                            "typeIconSmall": "https://host/…"
                        },
                        "attributes": [],
                        "_links": {
                            "self": {
                                "href": "https://host/…"
                            },
                            "profile": {
                                "href": "https://host/…"
                            },
                            "aa:thumb": {
                                "href": "https://host/…"
                            },
                            "aa:icon": {
                                "href": "https://host/…"
                            },
                            "loc:referenced-object": {
                                "href": "https://host/…"
                            },
                            "loc:update-item": {
                                "href": "https://host/…"
                            },
                            "loc:path-to-root": {
                                "href": "https://host/…"
                            }
                        },
                        "_embedded": {
                            "loc:referenced-object": {
                                "base": {
                                    "id": "Bear MPG",
                                    "type": "asset.VIDEO",
                                    "systemType": "interplay-mam",
                                    "systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
                                },
                                "common": {
                                    "name": "Bear MPG",
                                    "creator": "Service-WatchService",
                                    "created": "2017-02-14T14:06:18+01:00",
                                    "modifier": "Administrator",
                                    "modified": "2017-07-18T15:55:19+02:00",
                                    "startTC": "06:05:17:19",
                                    "endTC": "06:05:47:15",
                                    "durationTC": "00:00:29:21",
                                    "description": "Bear at the river"
                                },
                                "_links": {
                                    "self": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-asset": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-attributes": {
                                        "href": "https://host/…"
                                    },
                                    "aa:attributes": {
                                        "href": "https://host/…"
                                    },
                                    "aa:thumb": {
                                        "href": "https://host/…"
                                    },
                                    "aa:icon": {
                                        "href": "https://host/…"
                                    },
                                    "aa:time-based": {
                                        "href": "https://host/…"
                                    },
                                    "loc:referencing-items": {
                                        "href": "https://host/…"
                                    },
                                    "aa:keyframes": {
                                        "href": "https://host/…"
                                    }
                                }
                            }
                        }
                    },
                    {
                        "base": {
                            "id": "100.103",
                            "type": "folder-item",
                            "systemType": "interplay-mam",
                            "systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
                        },
                        "common": {
                            "name": "MA - IE_galleryview",
                            "creator": "admin",
                            "created": "2017-02-15T13:18:41.897+01:00",
                            "modifier": "admin",
                            "modified": "2017-02-15T13:18:41.897+01:00",
                            "typeIcon": "https://host/…",
                            "typeIconSmall": "https://host/…"
                        },
                        "attributes": [],
                        "_links": {
                            "self": {
                                "href": "https://host/…"
                            },
                            "profile": {
                                "href": "https://host/…"
                            },
                            "aa:thumb": {
                                "href": "https://host/…"
                            },
                            "aa:icon": {
                                "href": "https://host/…"
                            },
                            "loc:referenced-object": {
                                "href": "https://host/…"
                            },
                            "loc:update-item": {
                                "href": "https://host/…"
                            },
                            "loc:path": {
                                "href": "https://host/…"
                            }
                        },
                        "_embedded": {
                            "loc:referenced-object": {
                                "base": {
                                    "id": "MA - IE_galleryview",
                                    "type": "asset.IMAGE",
                                    "systemType": "interplay-mam",
                                    "systemID": "ea836abc-105a-11ea-8d71-362b9e155667"
                                },
                                "common": {
                                    "name": "MA - IE_galleryview",
                                    "creator": "Service-WatchService",
                                    "created": "2017-02-14T14:06:07+01:00",
                                    "modifier": "Service-WatchService",
                                    "modified": "2017-02-14T14:06:07+01:00",
                                    "startTC": "00:00:00.000"
                                },
                                "_links": {
                                    "self": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-asset": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-attributes": {
                                        "href": "https://host/…"
                                    },
                                    "aa:attributes": {
                                        "href": "https://host/…"
                                    },
                                    "aa:thumb": {
                                        "href": "https://host/…"
                                    },
                                    "aa:icon": {
                                        "href": "https://host/…"
                                    },
                                    "aa:time-based": {
                                        "href": "https://host/…"
                                    },
                                    "loc:referencing-items": {
                                        "href": "https://host/…"
                                    },
                                    "aa:keyframes": {
                                        "href": "https://host/…"
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }
    }
}

MediaCentral Production Management: location item that acts as an asset reference

 
{
    "base": {
        "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
        "systemType": "interplay-pam",
        "id": "/Projects/ka/test/",
        "type": "folder"
    },
    "common": {
        "creator": "ka",
        "created": "2018-06-27T12:51:21.195Z",
        "modifier": "ka",
        "name": "test",
        "modified": "2018-06-27T12:51:21.195Z"
    },
    "_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": "http://services.avid.com/apis/locations/{rel}",
                "templated": true
            },
            {
                "name": "aa",
                "href": "http://services.avid.com/apis/assets/{rel}",
                "templated": true
            },
            {
                "name": "pa",
                "href": "http://services.avid.com/apis/pam/assets/{rel}",
                "templated": true
            }
        ]
    },
    "_embedded": {
        "loc:collection": {
            "paging": {
                "limit": 25,
                "offset": 0,
                "elements": 2,
                "totalElements": 2
            },
            "_links": {
                "self": {
                    "href": "https://host/…"
                },
                "first": {
                    "href": "https://host/…"
                },
                "loc:locations": {
                    "href": "https://host/…"
                },
                "loc:item": [
                    {
                        "href": "https://host/…"
                    },
                    {
                        "href": "https://host/…"
                    }
                ]
            },
            "_embedded": {
                "loc:item": [
                    {
                        "base": {
                            "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
                            "systemType": "interplay-pam",
                            "id": "/Projects/ka/test/060a2b340101010101010f0013-000000-0e293900b3860011-060e2b347f7f-d080",
                            "type": "folder-item"
                        },
                        "common": {
                            "creator": "Administrator",
                            "durationTC": "00:00:20:00",
                            "editRate": "25/1",
                            "created": "2018-05-30T12:41:59.033Z",
                            "modifier": "Administrator",
                            "name": "2",
                            "endTC": "18:54:47:02",
                            "dropframe": false,
                            "modified": "2013-04-10T16:54:49Z",
                            "startTC": "18:54:27:02"
                        },
                        "_links": {
                            "self": {
                                "href": "https://host/…"
                            },
                            "loc:referenced-object": {
                                "href": "https://host/…"
                            },
                            "loc:path-to-root": {
                                "href": "https://host/…"
                            },
                            "loc:thumb": {
                                "href": "https://host/…"
                            },
                            "loc:update-item": {
                                "href": "https://host/…"
                            },
                            "loc:locations": {
                                "href": "https://host/…"
                            }
                        },
                        "_embedded": {
                            "loc:referenced-object": {
                                "base": {
                                    "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
                                    "systemType": "interplay-pam",
                                    "id": "060a2b340101010101010f0013-000000-0e293900b3860011-060e2b347f7f-d080",
                                    "type": "masterclip"
                                },
                                "common": {
                                    "creator": "Administrator",
                                    "durationTC": "00:00:20:00",
                                    "editRate": "25/1",
                                    "created": "2018-05-30T12:41:59.033Z",
                                    "modifier": "Administrator",
                                    "name": "2",
                                    "endTC": "18:54:47:02",
                                    "dropframe": false,
                                    "modified": "2013-04-10T16:54:49Z",
                                    "startTC": "18:54:27:02"
                                },
                                "_links": {
                                    "self": {
                                        "href": "https://host/…"
                                    },
                                    "aa:asset-by-id": {
                                        "href": "https://host/…"
                                    },
                                    "aa:assets": {
                                        "href": "https://host/…"
                                    },
                                    "aa:thumb": {
                                        "href": "https://host/…"
                                    },
                                    "aa:attributes": {
                                        "href": "https://host/…"
                                    },
                                    "aa:time-based": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-time-based": {
                                        "href": "https://host/…"
                                    },
                                    "aa:delete-time-based": {
                                        "href": "https://host/…"
                                    },
                                    "aa:update-asset": {
                                        "href": "https://host/…",
                                        "type": "application/hal+json"
                                    },
                                    "loc:referencing-items": {
                                        "href": "https://host/…"
                                    },
                                    "datamodel:asset-model": {
                                        "href": "https://host/…"
                                    }
                                }
                            }
                        }
                    },
                    {
                        "base": {
                            "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
                            "systemType": "interplay-pam",
                            "id": "/Projects/ka/test/1/",
                            "type": "folder"
                        },
                        "common": {
                            "creator": "ka",
                            "created": "2018-06-27T12:51:45.382Z",
                            "modifier": "ka",
                            "name": "1",
                            "modified": "2018-06-27T12:51:45.382Z"
                        },
                        "_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/…"
                            }
                        }
                    }
                ]
            }
        }
    }
}

MediaCentral Production Management: a folder item

 
{
    "base": {
        "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
        "systemType": "interplay-pam",
        "id": "/Projects/ka/test/060a2b340101010101010f0013-000000-0e293900b3860011-060e2b347f7f-d080",
        "type": "folder-item"
    },
    "common": {
        "creator": "Administrator",
        "durationTC": "00:00:20:00",
        "editRate": "25/1",
        "created": "2018-05-30T12:41:59.033Z",
        "modifier": "Administrator",
        "name": "2",
        "endTC": "18:54:47:02",
        "dropframe": false,
        "modified": "2013-04-10T16:54:49Z",
        "startTC": "18:54:27:02"
    },
    "_links": {
        "self": {
            "href": "https://host/…"
        },
        "loc:referenced-object": {
            "href": "https://host/…"
        },
        "loc:path-to-root": {
            "href": "https://host/…"
        },
        "loc:thumb": {
            "href": "https://host/…"
        },
        "loc:update-item": {
            "href": "https://host/…"
        },
        "loc:locations": {
            "href": "https://host/…"
        },
        "curies": [
            {
                "name": "loc",
                "href": "http://services.avid.com/apis/locations/{rel}",
                "templated": true
            },
            {
                "name": "aa",
                "href": "http://services.avid.com/apis/assets/{rel}",
                "templated": true
            },
            {
                "name": "pa",
                "href": "http://services.avid.com/apis/pam/assets/{rel}",
                "templated": true
            }
        ]
    },
    "_embedded": {
        "loc:referenced-object": {
            "base": {
                "systemID": "ea836abc-105a-11ea-8d71-362b9e155667",
                "systemType": "interplay-pam",
                "id": "060a2b340101010101010f0013-000000-0e293900b3860011-060e2b347f7f-d080",
                "type": "masterclip"
            },
            "common": {
                "creator": "Administrator",
                "durationTC": "00:00:20:00",
                "editRate": "25/1",
                "created": "2018-05-30T12:41:59.033Z",
                "modifier": "Administrator",
                "name": "2",
                "endTC": "18:54:47:02",
                "dropframe": false,
                "modified": "2013-04-10T16:54:49Z",
                "startTC": "18:54:27:02"
            },
            "_links": {
                "self": {
                    "href": "https://host/…"
                },
                "aa:asset-by-id": {
                    "href": "https://host/…"
                },
                "aa:assets": {
                    "href": "https://host/…"
                },
                "aa:thumb": {
                    "href": "https://host/…"
                },
                "aa:attributes": {
                    "href": "https://host/…"
                },
                "aa:time-based": {
                    "href": "https://host/…"
                },
                "aa:update-time-based": {
                    "href": "https://host/…"
                },
                "aa:delete-time-based": {
                    "href": "https://host/…"
                },
                "aa:update-asset": {
                    "href": "https://host/…",
                    "type": "application/hal+json"
                },
                "loc:referencing-items": {
                    "href": "https://host/…"
                },
                "datamodel:asset-model": {
                    "href": "https://host/…"
                }
            }
        }
    }
}