Link relation ia:queue-stories-by-id

Overview

Get the list of stories in a queue by the queue’s id.

HTTP method

GET

URI template variables

id

The id of the queue.

Query parameters

qkey

Password for key-locked queue.

offset

Number of items in the collection to skip (default value is 0).

after

The asset id where list should start from (the given asset is not included in the list). Use instead of offset param.

before

The asset id where list should start from. Use instead of offset param.

limit

The maximum number of items to return in response (default value is 25).

filter

A comma separated list of asset attributes with value (e.g. ON_AIR=true,IS_BREAK=false).

embed

A comma-separated list of sub resources to embed. Possible values:

  • asset-attributes: embeds the aa:attributes resource for the asset.

  • nsml: embeds the asset nsml.

section

Only if nsml is embedded

A comma-separated list of nsml sections. Possible values are head, form, fields, field-atts, body, aeset, aeset-atts, projects.

Request body

HTTP response

200 OK

400 Bad Request

The queue id is invalid.

404 Not Found

Response body

An ia:queue-stories resource

Available in