Resource ia:queue-watcher

Overview

The ia:queue-watcher resource represents a watcher object and provides links to manage it.

Properties

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

id

The id of the watcher.

events

The list of events to listen and notify. Acceptable events:

  • QUEUE_CHANGED - notify about any changes in the queue

  • STORY_ON_AIR_CHANGED - notify that current On-Air story changed.

Link Relations

ia:delete-queue-watcher

This link relation is deprecated, use ia:unsubscribe-from-queue-notifications instead. Remove a queue watcher object and unsubscribe the user from notifications.

ia:queue

Link to the queue.

Description

The ia:queue-watcher resource represents a watcher object and provides links to manage it.

Examples

Example: ia:queue-watcher 
 
{
  "id": 8612,
  "events": ["QUEUE_CHANGED", "ON_AIR_STORY_CHANGED"],
  "_links": {
    "curies": [
      {
        "name": "ia",
        "href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
        "templated": true
      }
    ],
    "ia:delete-queue-watcher": {
      "href": "https://host/.."
    },
    "ia:queue": {
      "href": "https://host/.."
    },
    "self": {
      "href": "https://host/.."
    }
  }
}