Resource ia:queue-stories

Overview

The ia:queue-stories resource represents the list of stories in a queue.

Properties

The ia:queue-stories resource has the following properties:

stories

An array of Common Objects where each object represents an asset.

paging

The paging object.

totalElements

The total amount of stories in the queue.

ia:queue

Link to the folder that contains the stories.

ia:copy-queue-stories

Copy stories from this queue to a different queue.

ia:move-queue-stories

Move stories from this queue to a different queue.

ia:order-queue-stories

Change the order of the stories in a queue.

ia:group-queue-stories

Group the stories in a queue.

ia:ungroup-queue-stories

Dissolve group of stories in a queue.

ia:delete-queue-stories

Delete the stories in a queue.

Description

The ia:queue-stories resource represents the list of stories in a queue.

Examples

Example: ia:queue-stories
 
{
  "stories": [
    {
      "base": {
        "id": "FOLDER.QUEUE..287082798.8699.11",
        "type": "story",
        "systemID": "INEWS6",
        "systemType": "inews"
      },
      "common": {
        "name": "Story 001",
        "creator": "avstar",
        "created": "2016-11-15T09:14:02.000Z",
        "modifier": "avstar",
        "modified": "2016-11-15T09:14:02.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:asset-nsml": {
          "href": "https://host/.."
        },
        "ia:lock-asset": {
          "href": "https://host/.."
        },
        "ia:versions": {
          "href": "https://host/.."
        },
        "self": {
          "href": "https://host/.."
        }
      }
    },
    {
      "base": {
        "id": "FOLDER.QUEUE..169043134.8699.10",
        "type": "story",
        "systemID": "INEWS6",
        "systemType": "inews"
      },
      "common": {
        "name": "Story 002",
        "creator": "avstar",
        "created": "2016-10-28T14:53:03.000Z",
        "modifier": "avstar",
        "modified": "2016-10-28T14:53:03.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:asset-nsml": {
          "href": "https://host/.."
        },
        "ia:lock-asset": {
          "href": "https://host/.."
        },
        "ia:versions": {
          "href": "https://host/.."
        },
        "self": {
          "href": "https://host/.."
        }
      }
    }
  ],
  "paging": {
    "elements": 2,
    "offset": 0,
    "limit": 25
  },
  "totalElements": 2,
  "_links": {
    "curies": [
      {
        "name": "aa",
        "href": "http://services.avid.com/apis/assets/{rel}",
        "templated": true
      },
      {
        "name": "ia",
        "href": "http://services.avid.com/apis/inews/assets/{rel}",
        "templated": true
      }
    ],
    "first": {
      "href": "https://host/.."
    },
    "ia:copy-queue-stories": {
      "href": "https://host/.."
    },
    "ia:delete-queue-stories": {
      "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": {
      "href": "https://host/.."
    },
    "ia:ungroup-queue-stories": {
      "href": "https://host/.."
    },
    "self": {
      "href": "https://host/.."
    }
  }
}