Resource ia:queue-attributes

Overview

The ia:queue-attributes resource represents the attributes of a queue.

Properties

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

attributes	An array of JSON objects where each object represents one queue attribute with it’s value. Each JSON object has the following sub properties: name: the name of the attribute value: the value of the attribute readonly: boolean value that shows that this attribute is only for reading or not

attributes

An array of JSON objects where each object represents one queue attribute with it’s value. Each JSON object has the following sub properties:

name: the name of the attribute
value: the value of the attribute
readonly: boolean value that shows that this attribute is only for reading or not

Link Relations

ia:queue	Link to the folder that contains those stories.
ia:update-attributes	Updates the queue attributes.

ia:queue

Link to the folder that contains those stories.

ia:update-attributes

Updates the queue attributes.

Description

The ia:queue-attributes resource represents the attributes of a queue.

List of Available Attributes

Name	Type	Value	Readonly	Description
EDIT_LOCKED	Boolean	True/False	Yes	Whether the queue has been locked for editing.
PRODUCTION_LOCKED	Boolean	True/False	Readonly	Whether the queue has been locked for production.
PURGE_LOCKED	Boolean	True/False	Yes	Whether the queue has been locked for cleanup old stories.
EASY_LOCKED	Boolean	True/False	Yes	Whether the queue has been locked by user.
KEY_LOCKED	Boolean	True/False	Yes	Whether the queue has been locked by user with password.
READ_GROUP	String	Group	No	Name of the group. Users that belogs to the group are allowed to read stories.
WRITE_GROUP	String	Group	No	Name of the group. Users that belogs to the group are allowed to create and edit stories.
EDITORIAL_GROUP	String	Group	No	Name of the group. Users that belogs to the group are allowed to reorder and delete stories.
NOTIFY_GROUP	String	Group	No	Name of the group. Users that belogs to that group will be notified about changes in the queue.
BATCH_ALLOWED	Boolean	True/False	No	Whether the user allowed to perform copy/move actions on all stories in the queue.
DISPLAY_LINES	Int	0..21	No	Number of lines of story body to show in queue view.
FORMS_ALLOWED	Boolean	True/False	No	Whether the queue allows to store custom form in story.
FTS_INDEXED	Boolean	True/False	No	FTS index number.
MEDIA_INDEXED	Boolean	True/False	No	Whether the queue stories are indexed by Media Index.
GENERAL	Boolean	True/False	No	Whether the queue is general.
INVERTED	Boolean	True/False	No	Whether the queue is inverted.
MONITORED	Boolean	True/False	No	Whether the queue is monitored.
ORDERED	Boolean	True/False	No	Whether the queue stories was ordered after sort.
PRINTABLE	Boolean	True/False	No	Whether the queue is printable.
PURGE_INTERVAL	Int	o..65535	No	Purge interval in hours.
QUEUE_FORM	String		No	Name of the form. Applied to queue view.
READ_ONLY	Boolean	True/False	No	Whether the queue is read-only.
REFRESH	Boolean	True/False	No	Whether the queue is refreshed.
SAVE_VERSIONS	Enum	LAST, ORIG, ALL, NONE	No	Controls how to store story versions.
SEQUENTIAL	Boolean	True/False	No	Sequential queue order
SHOW_TEXT_TIMING_CLOCKS	Boolean	True/False	No	Whether the queue shows timing clocks.
SKIP_ON_BACKUP	Boolean	True/False	No	Whether the queue is skipped on backup.
SORTED	Boolean	True/False	No	Whether the queue stories is sorted.
SORT_FIELD	String	0..19	No	Name of field to sort by.
STORY_FORM	String	0..63	No	Name of the form. Applied to all new stories that creates in this queue.
SYSTEM_MBOX	Int	0..10017	No	Number of system mailbox that refers to device number. Values above 10000 are system reserved and defined bellow.
UPDATE	Boolean	True/False	No	Whether the queue stories will be replaced on copy/move operation instead of creating new ones.
WATCH_APPENDS	Boolean	True/False	No	Almost the same as REFRESH but force client to mark stories that user not read.

Name

Type

Value

Readonly

Description

EDIT_LOCKED

Boolean

True/False

Yes

Whether the queue has been locked for editing.

PRODUCTION_LOCKED

Boolean

True/False

Readonly

Whether the queue has been locked for production.

PURGE_LOCKED

Boolean

True/False

Yes

Whether the queue has been locked for cleanup old stories.

EASY_LOCKED

Boolean

True/False

Yes

Whether the queue has been locked by user.

KEY_LOCKED

Boolean

True/False

Yes

Whether the queue has been locked by user with password.

READ_GROUP

String

Group

Name of the group. Users that belogs to the group are allowed to read stories.

WRITE_GROUP

String

Group

Name of the group. Users that belogs to the group are allowed to create and edit stories.

EDITORIAL_GROUP

String

Group

Name of the group. Users that belogs to the group are allowed to reorder and delete stories.

NOTIFY_GROUP

String

Group

Name of the group. Users that belogs to that group will be notified about changes in the queue.

BATCH_ALLOWED

Boolean

True/False

Whether the user allowed to perform copy/move actions on all stories in the queue.

DISPLAY_LINES

Int

0..21

Number of lines of story body to show in queue view.

FORMS_ALLOWED

Boolean

True/False

Whether the queue allows to store custom form in story.

FTS_INDEXED

Boolean

True/False

FTS index number.

MEDIA_INDEXED

Boolean

True/False

Whether the queue stories are indexed by Media Index.

GENERAL

Boolean

True/False

Whether the queue is general.

INVERTED

Boolean

True/False

Whether the queue is inverted.

MONITORED

Boolean

True/False

Whether the queue is monitored.

ORDERED

Boolean

True/False

Whether the queue stories was ordered after sort.

PRINTABLE

Boolean

True/False

Whether the queue is printable.

PURGE_INTERVAL

Int

o..65535

Purge interval in hours.

QUEUE_FORM

String

Name of the form. Applied to queue view.

READ_ONLY

Boolean

True/False

Whether the queue is read-only.

REFRESH

Boolean

True/False

Whether the queue is refreshed.

SAVE_VERSIONS

Enum

LAST, ORIG, ALL, NONE

Controls how to store story versions.

SEQUENTIAL

Boolean

True/False

Sequential queue order

SHOW_TEXT_TIMING_CLOCKS

Boolean

True/False

Whether the queue shows timing clocks.

SKIP_ON_BACKUP

Boolean

True/False

Whether the queue is skipped on backup.

SORTED

Boolean

True/False

Whether the queue stories is sorted.

SORT_FIELD

String

0..19

Name of field to sort by.

STORY_FORM

String

0..63

Name of the form. Applied to all new stories that creates in this queue.

SYSTEM_MBOX

Int

0..10017

Number of system mailbox that refers to device number. Values above 10000 are system reserved and defined bellow.

UPDATE

Boolean

True/False

Whether the queue stories will be replaced on copy/move operation instead of creating new ones.

WATCH_APPENDS

Boolean

True/False

Almost the same as REFRESH but force client to mark stories that user not read.

Reserved SYSTEM_MBOX values

Value	Description
10001	Broadcast to all terminals.
10002	Wire box for keyword changes.
10003	Only for internal use, do not set this value.
10004	System box for keyboard changes.
10005	Box for wire keyword check.
10006	Only for internal use, do not set this value.
10007	Box for wire distribution check.
10008	Only for internal use, do not set this value.
10009	Only for internal use, do not set this value.
10010	Box for monitor map check.
10011	Only for internal use, do not set this value.
10012	Only for internal use, do not set this value.
10013	Groups file mail box.
10014	Only for internal use, do not set this value.
10015	Only for internal use, do not set this value.
10016	Only for internal use, do not set this value.
10017	Only for internal use, do not set this value.

Examples

Example: ia:queue-attributes

 
{
  "attributes": [
    {
      "name": "BATCH_ALLOWED",
      "value": false
    },
    {
      "name": "DISPLAY_LINES",
      "value": 1
    },
    {
      "name": "EASY_LOCKED",
      "value": false,
      "readonly": true
    },
    {
      "name": "EDITORIAL_GROUP",
      "value": "none"
    },
    {
      "name": "EDIT_LOCKED",
      "value": false,
      "readonly": true
    },
    {
      "name": "FORMS_ALLOWED",
      "value": false
    },
    {
      "name": "FTS_INDEX",
      "value": 1
    },
    {
      "name": "FTS_INDEXED",
      "value": true
    },
    {
      "name": "GENERAL",
      "value": false
    },
    {
      "name": "INVERTED",
      "value": true
    },
    {
      "name": "KEY_LOCKED",
      "value": false,
      "readonly": true
    },
    {
      "name": "MEDIA_INDEXED",
      "value": false
    },
    {
      "name": "MONITORED",
      "value": false
    },
    {
      "name": "NOTIFY_GROUP",
      "value": "none"
    },
    {
      "name": "ORDERED",
      "value": false
    },
    {
      "name": "PRINTABLE",
      "value": false
    },
    {
      "name": "PRODUCTION_LOCKED",
      "value": false,
      "readonly": true
    },
    {
      "name": "PURGE_INTERVAL",
      "value": 0
    },
    {
      "name": "PURGE_LOCKED",
      "value": false,
      "readonly": true
    },
    {
      "name": "QUEUE_FORM",
      "value": "DEFAULT-FORM"
    },
    {
      "name": "READ_GROUP",
      "value": "none"
    },
    {
      "name": "READ_ONLY",
      "value": false
    },
    {
      "name": "REFRESH",
      "value": true
    },
    {
      "name": "SAVE_VERSIONS",
      "value": "LAST"
    },
    {
      "name": "SEQUENTIAL",
      "value": false
    },
    {
      "name": "SHOW_TEXT_TIMING_CLOCKS",
      "value": false
    },
    {
      "name": "SKIP_ON_BACKUP",
      "value": false
    },
    {
      "name": "SORTED",
      "value": false
    },
    {
      "name": "SORT_FIELD",
      "value": "TITLE"
    },
    {
      "name": "STORY_FORM",
      "value": "DEFAULT-FORM"
    },
    {
      "name": "SYSTEM_MBOX",
      "value": 0
    },
    {
      "name": "UPDATE",
      "value": false
    },
    {
      "name": "WATCH_APPENDS",
      "value": false
    },
    {
      "name": "WRITE_GROUP",
      "value": "none"
    }
  ],
  "_links": {
    "curies": [
      {
        "name": "ia",
        "href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
        "templated": true
      }
    ],
    "ia:queue": {
      "href": "http://host/…"
    },
    "ia:update-attributes": {
      "href": "http://host/…"
    },
    "self": {
      "href": "http://host/…"
    }
  }
}