Overview
The ia:queue resource represents a queue in an MediaCentral Newsroom Management system.
Properties
The ia:queue resource has the following properties:
base |
Base identifier of the queue. The property is a JSON object with the following sub properties:
|
|---|---|
common |
Common attributes:
|
Link Relations
Get the attributes of the queue. |
|
Copy stories from this queue to a different queue. |
|
This link relation is deprecated, use ia:subscribe-to-queue-notifications instead. Create a ia:queue-watcher object and subscribe the user to notifications about queue changes. |
|
Create a new story (aa:asset). |
|
Delete the stories in a queue. |
|
Get the status of a user’s subscription to ia:queue-notifications. |
|
Group the stories in a queue. |
|
Move stories from this queue to a different queue. |
|
Change the order of the stories in a queue. |
|
A list of ia:queue-stories (assets) in this queue. |
|
Subscribe user to ia:queue-notifications about queue changes. |
|
Dissolve group of stories in a queue. |
|
Unsubscribe user from ia:queue-notifications about queue changes. |
Description
The ia:queue resource represents a queue in an MediaCentral Newsroom Management system.
Examples
Example: ia:queue
{
"base": {
"id": "TEST.PLATFORM.QUEUE",
"type": "queue",
"systemID": "9ad25256-11e7-11ea-8d71-362b9e155667",
"systemType": "inews"
},
"common": {
"name": "QUEUE"
},
"_links": {
"curies": [
{
"name": "aa",
"href": "https://developer.avid.com/ctms/api/aa/linkrels/{rel}.html",
"templated": true
},
{
"name": "ia",
"href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
"templated": true
}
],
"ia:attributes": {
"href": "https://host/.."
},
"ia:copy-queue-stories": {
"href": "https://host/.."
},
"ia:create-queue-watcher": {
"href": "https://host/.."
},
"ia:create-story": {
"href": "https://host/..",
"type": "application/vnd.com.avid.inews.nsml+xml"
},
"ia:delete-queue": {
"href": "https://host/.."
},
"ia:delete-queue-stories": {
"href": "https://host/.."
},
"ia:get-status-of-queue-notifications": {
"href": "https://host/.."
},
"ia:group-queue-stories": {
"href": "https://host/.."
},
"ia:move-queue-stories": {
"href": "https://host/.."
},
"ia:order-queue-stories": {
"href": "https://host/.."
},
"ia:queue-stories": {
"href": "https://host/.."
},
"ia:subscribe-to-queue-notifications": {
"href": "https://host/.."
},
"ia:ungroup-queue-stories": {
"href": "https://host/.."
},
"ia:unsubscribe-from-queue-notifications": {
"href": "https://host/.."
},
"self": {
"href": "https://host/.."
}
},
"_embedded": {
"ia:queue-stories": {
"stories": [
{
"base": {
"id": "TEST.PLATFORM.QUEUE..389666279.8612.21",
"type": "story",
"systemID": "9ad25256-11e7-11ea-8d71-362b9e155667",
"systemType": "inews"
},
"common": {
"name": "STORY5",
"creator": "avstar",
"created": "2016-05-19T12:58:41.000Z",
"modifier": "avstar",
"modified": "2016-05-19T12:58:41.000Z"
},
"_links": {
"aa:attributes": {
"href": "https://host/.."
},
"aa:delete-asset": {
"href": "https://host/.."
},
"aa:update-asset": {
"href": "https://host/..",
"type": "application/vnd.com.avid.inews.nsml+xml",
"templated": true
},
"ia:lock-asset": {
"href": "https://host/.."
},
"ia:asset-nsml": {
"href": "https://host/.."
},
"self": {
"href": "https://host/.."
}
}
},
…
],
"paging": {
"elements": 7,
"offset": 0,
"limit": 25
},
"totalElements": 7,
"_links": {
"first": {
"href": "https://host/.."
},
"ia:queue": {
"href": "https://host/.."
},
"self": {
"href": "https://host/.."
}
}
}
}
}