Resource ia:searchqueue-attributes

Overview

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

Properties

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

attributes

An array of JSON objects. Each JSON 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 queue.

ia:update-attributes

Update the queue attributes.

Description

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

List of Available Attributes

Name Type Value Readonly Description

READ_GROUP

String

Group

No

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

QUEUE_FORM

String

No

Name of the form. Applied to queue view.

SEARCH_QUERY

String

No

Valid search query string.

Examples

Example: ia:queue-attributes 
 
{
  "attributes": [
    {
      "name": "QUEUE_FORM",
      "value": "DEFAULT-FORM"
    },
    {
      "name": "READ_GROUP",
      "value": "none"
    },
    {
      "name": "SEARCH_QUERY",
      "value": "{MaxFound=100 [INEWS6]FOLDER.QUEUE}weather&fine"
    }
  ],
  "_links": {
    "curies": [
      {
        "name": "ia",
        "href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
        "templated": true
      }
    ],
    "ia:queue": {
      "href": "https://host/.."
    },
    "ia:update-attributes": {
      "href": "https://host/.."
    },
    "self": {
      "href": "https://host/.."
    }
  }
}