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 foundations of all NMOS resources",
"title": "Base resource",
"additionalProperties": false,
"properties": {
"label": {
"description": "Freeform string label for the resource. Set to null to restore default label.",
"type": ["null", "string"]
},
"description": {
"description": "Detailed description of the resource. Set to null to restore default description.",
"type": ["null", "string"]
},
"tags": {
"description": "Key value set of freeform string tags to aid in filtering resources. Set to null to restore default tags. Values should be represented as an array of strings. Can be empty. Set to null to delete or restore default values for a tag.",
"type": ["null", "object"],
"patternProperties": {
"": {
"type": ["null", "array"],
"items": {
"type": "string"
}
}
}
}
}
}
Examples:
label-description:
{
"label": "fave node",
"description": "my favourite node"
}
tags:
{
"tags": {
"location": null,
"studio": ["HQ2"]
}
}
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Describes the foundations of all NMOS resources",
"title": "Base resource",
"required": [
"id",
"version",
"label",
"description",
"tags"
],
"properties": {
"id": {
"description": "Globally unique identifier for the resource",
"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}$"
},
"version": {
"description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed",
"type": "string",
"pattern": "^[0-9]+:[0-9]+$"
},
"label": {
"description": "Freeform string label for the resource",
"type": "string"
},
"description": {
"description": "Detailed description of the resource",
"type": "string"
},
"tags": {
"description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.",
"type": "object",
"patternProperties": {
"": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
Example:
{
"version": "1441700172:318426300",
"label": "host1",
"description": "host1",
"tags": {},
"id": "3b8be755-08ff-452b-b217-c9151eb21193"
}
HTTP status code 400
Returned when the request did not meet the schema
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 500
Returned when the request did not meet the API's additional constraints
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"]
}
}
}