Resource ia:monitor-servers

Overview

The ia:monitor-servers resource represents a list of configured servers for the monitor.

Properties

The ia:monitor-servers resource has the following properties:

servers

An array of servers resources. Each object represents a server description that has the following properties:

  • serverType - type of the server, can be wnasvr, mossvr

  • serverName - name of the server

  • cawsForm - form name, this field shows only for mossvr servers

  • devices - list of configured devices for server

Each device object has the following properties:

  • type - device type, can be video, cg or mos

  • name - device name

  • channel - device channel, this field shows only for video and cg devices

  • style - device style, this field shows only for cg devices

  • validate - enable/disable device validation, this field shows only for cg devices

  • mosRedirectionList - list of mos devices to redirect messages, this field shows only for mos devices

  • sendStoryText - enable/disable send story text to mos device, this field shows only for mos devices

Link Relations

ia:monitor

Link to the monitor.

Description

The ia:monitor-servers resource represents a list of configured servers for the monitor.

Examples

Example: ia:monitor-servers 
 
{
    "servers": [
        {
            "serverType": "wnasvr",
            "serverName": "Command1",
            "devices": [
                {
                    "type": "video",
                    "name": "video",
                    "channel": "A"
                },
                {
                    "type": "cg",
                    "name": "cg",
                    "channel": "1",
                    "style": "news",
                    "validate": true
                }
            ]
        },
        {
            "serverType": "wnasvr",
            "serverName": "Command2",
            "devices": [
                {
                    "type": "video",
                    "name": "video",
                    "channel": "A"
                },
                {
                    "type": "cg",
                    "name": "cg",
                    "channel": "1",
                    "style": "news",
                    "validate": true
                }
            ]
        },
        {
            "serverType": "mossvr",
            "serverName": "mos1a",
            "cawsForm": "event-mos",
            "devices": [
                {
                    "type": "mos",
                    "name": "amcpA",
                    "mosRedirectionList": [
                        "amcpA1",
                        "amcpA2",
                        "amcpA3"
                    ],
                    "sendStoryText": true
                },
                {
                    "type": "mos",
                    "name": "amcpB",
                    "mosRedirectionList": [
                        "amcpB1",
                        "amcpB2",
                        "amcpB3"
                    ],
                    "sendStoryText": true
                }
            ]
        },
        {
            "serverType": "mossvr",
            "serverName": "mos1b",
            "cawsForm": "event-mos",
            "devices": [
                {
                    "type": "mos",
                    "name": "amcpA",
                    "mosRedirectionList": [
                        "amcpA1",
                        "amcpA2",
                        "amcpA3"
                    ],
                    "sendStoryText": true
                },
                {
                    "type": "mos",
                    "name": "amcpB",
                    "mosRedirectionList": [
                        "amcpB1",
                        "amcpB2",
                        "amcpB3"
                    ],
                    "sendStoryText": true
                }
            ]
        }
    ],
    "_links": {
        "curies": [
            {
                "name": "ia",
                "href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
                "templated": true
            }
        ],
        "ia:monitor": {
            "href": "https://host/…​"
        },
        "self": {
            "href": "https://host/…​"
        }
    }
}