Node API documentation version v1.3

http://api.example.com/x-nmos/node/{version}

  • version: required(v1.3)

Overview

The Node API is exposed by each NMOS Node in a system, regardless of whether it is possible for that Node to provide NMOS resources such as Flows, Sources etc. Data exposed by the Node API is used to populate the (distributed) registry via the Registration API. In smaller deployments the Node API is fetched from directly as required by Nodes which implement the peer-to-peer specification.

Further Documentation

Further normative documentation covering the behaviour of this API is contained in the docs folder of this repository.

Base

get

get

List of paths available from this API

List of paths available from this API

HTTP status code 200

Body

Media type: application/json

Type:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "description": "Describes the Node API base resource",
  "title": "Node API base resource",
  "items": {
    "type": "string",
    "enum": [
      "self/",
      "sources/",
      "flows/",
      "devices/",
      "senders/",
      "receivers/"
    ]
  },
  "minItems": 6,
  "maxItems": 6,
  "uniqueItems": true
}

Example:

[
    "self/", 
    "sources/", 
    "flows/", 
    "devices/", 
    "senders/", 
    "receivers/"
]

Self

get

get

Get information about this Node

Sources

get

get

List Sources

get

get

Get a single Source

Get a single Source

URI Parameters

  • sourceId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a Source",
  "title": "Source resource",
  "oneOf": [
    { "$ref": "source_generic.json" },
    { "$ref": "source_audio.json" },
    { "$ref": "source_data.json" }
  ]
}

Example:

{
    "description": "Capture Card Source Video",
    "tags": {
        "host": [
            "host1"
        ]
    },
    "format": "urn:x-nmos:format:video",
    "caps": {},
    "version": "1441703336:902850419",
    "parents": [],
    "label": "CaptureCardSourceVideo",
    "id": "4569cea2-ab63-4f97-8dd1-bad4669ea5e4",
    "device_id": "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5",
    "clock_name": "clk1"
}

HTTP status code 404

Returned when the requested Source ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Source ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/sources/4569cea2-ab63-4f97-8dd1-bad4669ea5e4

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

Flows

get

get

List Flows

get

get

Get a single Flow

Get a single Flow

URI Parameters

  • flowId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a Flow",
  "title": "Flow resource",
  "anyOf": [
    { "$ref": "flow_video_raw.json" },
    { "$ref": "flow_video_coded.json" },
    { "$ref": "flow_audio_raw.json" },
    { "$ref": "flow_audio_coded.json" },
    { "$ref": "flow_data.json" },
    { "$ref": "flow_sdianc_data.json" },
    { "$ref": "flow_json_data.json" },
    { "$ref": "flow_mux.json" }
  ]
}

Example:

{
    "description": "Test Card",
    "tags": {},
    "format": "urn:x-nmos:format:video",
    "label": "Test Card",
    "version": "1441704616:587121295",
    "parents": [],
    "source_id": "02c46999-d532-4c52-905f-2e368a2af6cb",
    "device_id": "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5",
    "id": "5fbec3b1-1b0f-417d-9059-8b94a47197ed",
    "media_type": "video/raw",
    "frame_width": 1920,
    "frame_height": 1080,
    "interlace_mode": "interlaced_tff",
    "colorspace": "BT709",
    "components": [
        {
            "name": "Y",
            "width": 1920,
            "height": 1080,
            "bit_depth": 10
        },
        {
            "name": "Cb",
            "width": 960,
            "height": 1080,
            "bit_depth": 10
        },
        {
            "name": "Cr",
            "width": 960,
            "height": 1080,
            "bit_depth": 10
        }
    ]
}

HTTP status code 404

Returned when the requested Flow ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Flow ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/flows/5fbec3b1-1b0f-417d-9059-8b94a47197ed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

Devices

get

get

List Devices

get

get

Get a single Device

Get a single Device

URI Parameters

  • deviceId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a Device",
  "title": "Device resource",
  "allOf": [
    { "$ref": "resource_core.json" },
    {
      "type": "object",
      "required": [
        "type",
        "node_id",
        "senders",
        "receivers",
        "controls"
      ],
      "properties": {
        "type": {
          "description": "Device type URN",
          "type": "string",
          "oneOf": [
            {
              "pattern": "^urn:x-nmos:device:"
            },
            {
              "not": {
                "pattern": "^urn:x-nmos:"
              }
            }
          ],
          "format": "uri"
        },
        "node_id": {
          "description": "Globally unique identifier for the Node which initially created the Device. This attribute is used to ensure referential integrity by registry implementations.",
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "senders": {
          "description": "UUIDs of Senders attached to the Device (deprecated)",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          }
        },
        "receivers": {
          "description": "UUIDs of Receivers attached to the Device (deprecated)",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          }
        },
        "controls": {
          "description": "Control endpoints exposed for the Device",
          "type": "array",
          "items": {
            "type": "object",
            "required": ["href", "type"],
            "properties": {
              "href": {
                "type": "string",
                "description": "URL to reach a control endpoint, whether http or otherwise",
                "format": "uri"
              },
              "type": {
                "type": "string",
                "description": "URN identifying the control format",
                "format": "uri"
              },
              "authorization": {
                "type": "boolean",
                "description": "This endpoint requires authorization",
                "default": false
              }
            }
          }
        }
      }
    }
  ]
}

Example:

{
    "receivers": [],
    "label": "pipeline 1 default device",
    "description": "pipeline 1 default device",
    "tags": {},
    "version": "1441703338:962976113",
    "id": "67c25159-ce25-4000-a66c-f31fff890265",
    "type": "urn:x-nmos:device:pipeline",
    "senders": [],
    "node_id": "3b8be755-08ff-452b-b217-c9151eb21193",
    "controls": [
        {
            "type": "urn:x-manufacturer:control:generic",
            "href": "ws://182.54.54.75:223"
        },
        {
            "type": "urn:x-manufacturer:control:generic",
            "href": "http://134.24.64.22/x-manufacturer/control/"
        },
        {
            "type": "urn:x-manufacturer:control:legacy",
            "href": "telnet://120.43.64.3:8080"
        }
    ]
}

HTTP status code 404

Returned when the requested Device ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Device ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/devices/67c25159-ce25-4000-a66c-f31fff890265

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

Senders

get

get

List Senders

get

get

Get a single Sender

Get a single Sender

URI Parameters

  • senderId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a sender",
  "title": "Sender resource",
  "allOf": [
    { "$ref": "resource_core.json" },
    {
      "type": "object",
      "required": [
        "flow_id",
        "transport",
        "device_id",
        "manifest_href",
        "interface_bindings",
        "subscription"
      ],
      "properties": {
        "caps": {
          "description": "Capabilities of this sender",
          "type": "object",
          "properties": {
          }
        },
        "flow_id": {
          "description": "ID of the Flow currently passing via this Sender. Set to null when a Flow is not currently internally routed to the Sender.",
          "type": ["string", "null"],
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "default": null
        },
        "transport": {
          "description": "Transport type used by the Sender in URN format",
          "type": "string",
          "oneOf": [
            {
              "pattern": "^urn:x-nmos:transport:"
            },
            {
              "not": {
                "pattern": "^urn:x-nmos:"
              }
            }
          ],
          "format": "uri"
        },
        "device_id": {
          "description": "Device ID which this Sender forms part of. This attribute is used to ensure referential integrity by registry implementations.",
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "manifest_href": {
          "description": "HTTP(S) accessible URL to a file describing how to connect to the Sender. Set to null when the transport type used by the Sender does not require a transport file.",
          "type": ["string", "null"],
          "format": "uri"
        },
        "interface_bindings": {
          "description": "Binding of Sender egress ports to interfaces on the parent Node.",
          "type": "array",
          "items": {
            "type":"string"
          }
        },
        "subscription": {
          "description": "Object indicating how this Sender is currently configured to send data.",
          "type": "object",
          "required": ["receiver_id", "active"],
          "properties": {
            "receiver_id": {
              "type": ["string", "null"],
              "description": "UUID of the Receiver to which this Sender is currently configured to send data. Only set if it is active, uses a unicast push-based transport and is sending to an NMOS Receiver; otherwise null.",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
              "default": null
            },
            "active": {
              "type": "boolean",
              "description": "Sender is enabled and configured to send data",
              "default": false
            }
          }
        }
      }
    }
  ]
}

Example:

{
    "description": "Test Card",
    "label": "Test Card",
    "version": "1441704616:890020555",
    "manifest_href": "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp",
    "flow_id": "5fbec3b1-1b0f-417d-9059-8b94a47197ed",
    "id": "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e",
    "transport": "urn:x-nmos:transport:rtp.mcast",
    "device_id": "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5",
    "interface_bindings":[
      "eth0",
      "eth1"
    ],
    "caps": {},
    "tags": {},
    "subscription": {
      "receiver_id": null,
      "active": true
    }
}

HTTP status code 404

Returned when the requested Sender ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Sender ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

Receivers

get

get

List Receivers

get

get

Get a single Receiver

Get a single Receiver

URI Parameters

  • receiverId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a Receiver",
  "title": "Receiver resource",
  "oneOf": [
    { "$ref": "receiver_video.json" },
    { "$ref": "receiver_audio.json" },
    { "$ref": "receiver_data.json" },
    { "$ref": "receiver_mux.json" }
  ]
}

Example:

{
    "description": "",
    "format": "urn:x-nmos:format:video",
    "tags": {},
    "caps": {
        "media_types": [
            "video/raw"
        ]
    },
    "subscription": {
        "sender_id": "2683ad14-642f-459d-a169-ef91c76cec6b",
        "active": true
    },
    "version": "1441704532:450093308",
    "label": "RTPRx",
    "id": "1eb53d65-ac83-441c-86f6-9b27df30ef0c",
    "transport": "urn:x-nmos:transport:rtp",
    "interface_bindings": [
      "eth0",
      "eth1"
    ],
    "device_id": "05017e08-b329-45f9-a566-a3f99cc11e4d"
}

HTTP status code 404

Returned when the requested Receiver ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Receiver ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/receivers/1eb53d65-ac83-441c-86f6-9b27df30ef0c

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

options put

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

put

Request a change to a Receiver's subscription (deprecated)

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

URI Parameters

  • receiverId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

HTTP status code 200

HTTP status code 403

Request a change to a Receiver's subscription (deprecated)

URI Parameters

  • receiverId: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the possible requests to a Node's Receiver target resource",
  "title": "Receiver target resource",
  "oneOf": [
    { "$ref": "sender.json" },
    {
      "type": "object",
      "description": "Describes an empty object",
      "title": "Empty object schema",
      "additionalProperties": false,
      "properties": {
      }
    }
  ]
}

Example:

{
    "description": "Test Card",
    "label": "Test Card",
    "version": "1441704616:890020555",
    "manifest_href": "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp",
    "flow_id": "5fbec3b1-1b0f-417d-9059-8b94a47197ed",
    "id": "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e",
    "transport": "urn:x-nmos:transport:rtp.mcast",
    "device_id": "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5",
    "interface_bindings":[
      "eth0",
      "eth1"
    ],
    "caps": {},
    "tags": {},
    "subscription": {
      "receiver_id": null,
      "active": true
    }
}

HTTP status code 202

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the possible requests to a Node's Receiver target resource",
  "title": "Receiver target resource",
  "oneOf": [
    { "$ref": "sender.json" },
    {
      "type": "object",
      "description": "Describes an empty object",
      "title": "Empty object schema",
      "additionalProperties": false,
      "properties": {
      }
    }
  ]
}

Example:

{
    "description": "Test Card",
    "label": "Test Card",
    "version": "1441704616:890020555",
    "manifest_href": "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp",
    "flow_id": "5fbec3b1-1b0f-417d-9059-8b94a47197ed",
    "id": "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e",
    "transport": "urn:x-nmos:transport:rtp.mcast",
    "device_id": "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5",
    "interface_bindings":[
      "eth0",
      "eth1"
    ],
    "caps": {},
    "tags": {},
    "subscription": {
      "receiver_id": null,
      "active": true
    }
}

HTTP status code 400

Returned when the PUT request is incorrectly formatted or missing mandatory attributes

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 404

Returned when the requested Receiver ID does not exist

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 409

Returned when the requested Receiver ID exists at a higher API version, and the resource cannot be conformed to the requested API version. The correct API version is identified via the Location header.

Headers

  • Location: required(string)

    Example:

    /x-nmos/node/{version}/receivers/1eb53d65-ac83-441c-86f6-9b27df30ef0c/target

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}

HTTP status code 501

This feature has not been implemented due to deprecation

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the standard error response which is returned with HTTP codes 400 and above",
  "title": "Error response",
  "required": [
    "code",
    "error",
    "debug"
  ],
  "properties": {
    "code": {
      "description": "HTTP error code",
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "error": {
      "description": "Human readable message which is suitable for user interface display, and helpful to the user",
      "type": "string"
    },
    "debug": {
      "description": "Debug information which may assist a programmer working with the API",
      "type": ["null", "string"]
    }
  }
}