Stream Compatibility Management API documentation version v1.0
http://api.example.com/x-nmos/streamcompatibility/{version}
- version: required(v1.0)
Base
List of resources available from this API - Inputs, Outputs, Senders, and Receivers. Each are compulsory parts of the spec.
get /
List of resources available from this API - Inputs, Outputs, Senders, and Receivers. Each are compulsory parts of the spec.
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API base resource",
"title": "Stream Compatibility Management API base resource",
"items": {
"type": "string",
"enum": [
"inputs/",
"outputs/",
"senders/",
"receivers/"
]
},
"minItems": 4,
"maxItems": 4,
"uniqueItems": true
}
Example:
[
"inputs/",
"outputs/",
"senders/",
"receivers/"
]
Senders
Sender root
get /senders
Sender root
HTTP status code 200
List Senders managed with IS-11. All UUIDs are appended with / to indicate that the ID forms part of the URL for the next layer down.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"title": "List of resources",
"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}/$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae/",
"171d5c80-7fff-4c23-9383-46503eb1c63e/",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8/"
]
List all the API endpoints for a single sender.
get /senders/{senderId}
List all the API endpoints for a single sender.
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /senders/{senderId} base resource",
"title": "Stream Compatibility Management API /senders/{senderId} base resource",
"items": {
"type": "string",
"enum": [
"constraints/",
"inputs/",
"status/"
]
},
"minItems": 3,
"maxItems": 3,
"uniqueItems": true
}
Example:
[
"constraints/",
"inputs/",
"status/"
]
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
List of Inputs associated with the Sender.
get /senders/{senderId}/inputs
List of Inputs associated with the Sender.
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"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}$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae",
"171d5c80-7fff-4c23-9383-46503eb1c63e",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8"
]
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Shows whether the Sender adheres to Active Constraints and indicates a reason if it does not
get /senders/{senderId}/status
Shows whether the Sender adheres to Active Constraints and indicates a reason if it does not
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Status of Sender",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"unconstrained",
"constrained",
"active_constraints_violation",
"no_essence",
"awaiting_essence"
]
},
"debug": {
"description": "Debug information which may give additional information on the state",
"type": "string"
}
}
}
Example:
{
"state": "unconstrained"
}
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Constraints root
get /senders/{senderId}/constraints
Constraints root
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /senders/{senderId}/constraints base resource",
"title": "Stream Compatibility Management API /senders/{senderId}/constraints base resource",
"items": {
"type": "string",
"enum": [
"active/",
"supported/"
]
},
"minItems": 2,
"maxItems": 2,
"uniqueItems": true
}
Example:
[
"active/",
"supported/"
]
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Shows the Active Constraints.
A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
Validates proposed Constraints against JSON Schema of request body and Supported Parameter Constraints and upon success replaces Active Constraints with the new ones.
Resets the Active Constraints.
get /senders/{senderId}/constraints/active
Shows the Active Constraints.
URI Parameters
- senderId: required(string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Describes Constraints",
"title": "Constraints",
"type": "object",
"required": [
"constraint_sets"
],
"properties": {
"constraint_sets": {
"type": "array",
"items": {
"$ref": "constraint_set.json"
}
}
}
}
Example:
{
"constraint_sets": [
{
"urn:x-nmos:cap:meta:label": "1080i Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "interlaced_tff" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 25, "denominator": 1 },
{ "numerator": 30000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
},
{
"urn:x-nmos:cap:meta:label": "1080p Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "progressive" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 24000, "denominator": 1001 },
{ "numerator": 50, "denominator": 1 },
{ "numerator": 60000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
}
]
}
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
put /senders/{senderId}/constraints/active
Validates proposed Constraints against JSON Schema of request body and Supported Parameter Constraints and upon success replaces Active Constraints with the new ones.
URI Parameters
- senderId: required(string)
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Describes Constraints",
"title": "Constraints",
"type": "object",
"required": [
"constraint_sets"
],
"properties": {
"constraint_sets": {
"type": "array",
"items": {
"$ref": "constraint_set.json"
}
}
}
}
Example:
{
"constraint_sets": [
{
"urn:x-nmos:cap:meta:label": "1080i Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "interlaced_tff" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 25, "denominator": 1 },
{ "numerator": 30000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
},
{
"urn:x-nmos:cap:meta:label": "1080p Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "progressive" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 24000, "denominator": 1001 },
{ "numerator": 50, "denominator": 1 },
{ "numerator": 60000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
}
]
}
HTTP status code 200
Returned when this Sender supports Parameter Constraint URNs used and all of Parameter Constraint values in all of Constraint Sets.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Describes Constraints",
"title": "Constraints",
"type": "object",
"required": [
"constraint_sets"
],
"properties": {
"constraint_sets": {
"type": "array",
"items": {
"$ref": "constraint_set.json"
}
}
}
}
Example:
{
"constraint_sets": [
{
"urn:x-nmos:cap:meta:label": "1080i Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "interlaced_tff" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 25, "denominator": 1 },
{ "numerator": 30000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
},
{
"urn:x-nmos:cap:meta:label": "1080p Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "progressive" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 24000, "denominator": 1001 },
{ "numerator": 50, "denominator": 1 },
{ "numerator": 60000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
}
]
}
HTTP status code 400
Returned when the Constraints are rejected due to schema validation failure or if the Sender doesn't support a Parameter Constraint URN used in any of the Constraint Sets.
Body
Media type: application/json
Type:
{
"$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 Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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 422
Returned when the Sender isn't capable to adhere to the proposed Constraints although the request is valid and the Sender supports all the Parameter Constraint URNs used.
Body
Media type: application/json
Type:
{
"$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 423
Returned when the Constraints can't be applied temporarily due to Device restrictions (e.g. if the Sender is active).
Body
Media type: application/json
Type:
{
"$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 if the Constraints can't be applied due to a reason not listed above.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
delete /senders/{senderId}/constraints/active
Resets the Active Constraints.
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Describes empty Constraints",
"title": "Constraints",
"required": [
"constraint_sets"
],
"properties": {
"constraint_sets": {
"type": "array",
"items": {
"$ref": "constraint_set.json"
},
"minItems": 0,
"maxItems": 0
}
}
}
Example:
{
"constraint_sets": []
}
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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 423
Returned when the Active Constraints can't be reset temporarily due to Device restrictions (e.g. if the Sender is active).
Body
Media type: application/json
Type:
{
"$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 Active Constraints can't be reset due to a reason not listed above.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Lists Constraints supported by the Sender
get /senders/{senderId}/constraints/supported
Lists Constraints supported by the Sender
URI Parameters
- senderId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"required": [
"parameter_constraints"
],
"properties": {
"parameter_constraints": {
"type": "array",
"items": {
"type": "string",
"anyOf": [
{
"enum": [
"urn:x-nmos:cap:meta:label",
"urn:x-nmos:cap:meta:preference",
"urn:x-nmos:cap:meta:enabled",
"urn:x-nmos:cap:format:media_type",
"urn:x-nmos:cap:format:grain_rate",
"urn:x-nmos:cap:format:frame_width",
"urn:x-nmos:cap:format:frame_height",
"urn:x-nmos:cap:format:interlace_mode",
"urn:x-nmos:cap:format:color_sampling",
"urn:x-nmos:cap:format:component_depth",
"urn:x-nmos:cap:format:channel_count",
"urn:x-nmos:cap:format:sample_rate",
"urn:x-nmos:cap:format:sample_depth"
]
},
{
"pattern": "^urn:x-nmos:cap:"
}
]
},
"uniqueItems": true
}
}
}
Example:
{
"parameter_constraints": [
"urn:x-nmos:cap:meta:label",
"urn:x-nmos:cap:meta:preference",
"urn:x-nmos:cap:meta:enabled",
"urn:x-nmos:cap:format:media_type",
"urn:x-nmos:cap:format:grain_rate",
"urn:x-nmos:cap:format:frame_width",
"urn:x-nmos:cap:format:frame_height",
"urn:x-nmos:cap:format:interlace_mode",
"urn:x-nmos:cap:format:colorspace",
"urn:x-nmos:cap:format:color_sampling",
"urn:x-nmos:cap:format:component_depth",
"urn:x-nmos:cap:format:channel_count",
"urn:x-nmos:cap:format:sample_rate",
"urn:x-nmos:cap:format:sample_depth",
"urn:x-nmos:cap:format:event_type",
"urn:x-nmos:cap:transport:packet_time",
"urn:x-nmos:cap:transport:max_packet_time",
"urn:x-nmos:cap:transport:st2110_21_sender_type"
]
}
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$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
List Receivers managed with IS-11. All UUIDs are appended with / to indicate that the ID forms part of the URL for the next layer down.
get /receivers
List Receivers managed with IS-11. All UUIDs are appended with / to indicate that the ID forms part of the URL for the next layer down.
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"title": "List of resources",
"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}/$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae/",
"171d5c80-7fff-4c23-9383-46503eb1c63e/",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8/"
]
List all the API endpoints for a single receiver.
get /receivers/{receiverId}
List all the API endpoints for a single receiver.
URI Parameters
- receiverId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /receivers/{receiverId} base resource",
"title": "Stream Compatibility Management API /receivers/{receiverId} base resource",
"items": {
"type": "string",
"enum": [
"outputs/",
"status/"
]
},
"minItems": 2,
"maxItems": 2,
"uniqueItems": true
}
Example:
[
"outputs/",
"status/"
]
HTTP status code 404
Returned when the requested Receiver ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Shows whether the Receiver is configured properly for receiving a stream and indicates a reason if it is not
get /receivers/{receiverId}/status
Shows whether the Receiver is configured properly for receiving a stream and indicates a reason if it is not
URI Parameters
- receiverId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Status of Receiver",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"unknown",
"compliant_stream",
"non_compliant_stream"
]
},
"debug": {
"description": "Debug information which may give additional information on the state",
"type": "string"
}
}
}
Example:
{
"state": "compliant_stream"
}
HTTP status code 404
Returned when the requested Receiver ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
get /receivers/{receiverId}/outputs
URI Parameters
- receiverId: required(string)
HTTP status code 200
List of Outputs associated with the Receiver.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"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}$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae",
"171d5c80-7fff-4c23-9383-46503eb1c63e",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8"
]
HTTP status code 404
Returned when the requested Receiver ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Inputs
get /inputs
HTTP status code 200
List of Inputs. All UUIDs are appended with / to indicate that the ID forms part of the URL for the next layer down.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"title": "List of resources",
"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}/$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae/",
"171d5c80-7fff-4c23-9383-46503eb1c63e/",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8/"
]
List all the API endpoints for a single Input.
get /inputs/{inputId}
List all the API endpoints for a single Input.
URI Parameters
- inputId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /inputs/{inputId} and /outputs/{outputId} base resource",
"title": "Stream Compatibility Management API /inputs/{inputId} and /outputs/{outputId} base resource",
"items": {
"type": "string",
"enum": [
"edid/",
"properties/"
]
},
"minItems": 2,
"maxItems": 2,
"uniqueItems": true
}
Example:
[
"edid/",
"properties/"
]
HTTP status code 404
Returned when the requested Input ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Return properties of the Input.
get /inputs/{inputId}/properties
Return properties of the Input.
URI Parameters
- inputId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes an Input",
"title": "Input resource",
"allOf": [
{ "$ref": "resource_core.json" },
{
"type": "object",
"required": [
"base_edid_support",
"connected",
"edid_support",
"status",
"device_id"
],
"properties": {
"adjust_to_caps": {
"description": "Whether the Input is configured to adjust Base EDID to internal capabilities. The property exists if the Input supports this feature",
"type": "boolean"
},
"base_edid_support": {
"description": "Whether the Input supports Base EDID",
"type": "boolean"
},
"connected": {
"description": "Whether the upstream counterpart of this Input is connected",
"type": "boolean"
},
"edid_support": {
"description": "Whether the Input supports EDID",
"type": "boolean"
},
"status": {
"description": "Status of Input",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"no_signal",
"awaiting_signal",
"signal_present"
]
},
"debug": {
"description": "Debug information which may give additional information on the state",
"type": "string"
}
}
},
"device_id": {
"description": "Device ID which this Input forms part of",
"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}$"
}
}
}
]
}
Example:
{
"id": "a2655c48-8a46-4c82-b9bc-98760d59d7f8",
"version": "1441704616:592733244",
"label": "Video card 1",
"description": "Video card in the PC placed in the office",
"device_id": "8ff471c6-bf77-51b1-92e7-939d18d82802",
"tags": {},
"base_edid_support": true,
"connected": true,
"edid_support": true,
"status": {
"state": "signal_present"
}
}
HTTP status code 404
Returned when the requested Input ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
List all the API endpoints for EDIDs associated with the Input.
get /inputs/{inputId}/edid
List all the API endpoints for EDIDs associated with the Input.
URI Parameters
- inputId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /inputs/{inputId}/edid base resource",
"title": "Stream Compatibility Management API /inputs/{inputId}/edid base resource",
"items": {
"type": "string",
"enum": [
"base/",
"effective/"
]
},
"minItems": 2,
"maxItems": 2,
"uniqueItems": true
}
Example:
[
"base/",
"effective/"
]
HTTP status code 404
Returned when the requested Input ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Redirects to the location of the Base EDID file or returns the Base EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the Base EDID file directly ensure that the Content-Type entity header is correctly set.
A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
Set Base EDID
Remove Base EDID
get /inputs/{inputId}/edid/base
Redirects to the location of the Base EDID file or returns the Base EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the Base EDID file directly ensure that the Content-Type entity header is correctly set.
URI Parameters
- inputId: required(string)
HTTP status code 200
The Base EDID file itself.
Body
Media type: application/octet-stream
Type: file
HTTP status code 204
There is no Base EDID set or the Input doesn't support Base EDID or EDID at all.
HTTP status code 307
A temporary redirect to the Base EDID file.
HTTP status code 404
Returned when the requested Input ID doesn't exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
put /inputs/{inputId}/edid/base
Set Base EDID
URI Parameters
- inputId: required(string)
Query Parameters
- adjust_to_caps: (boolean)
Sets the value of "adjust_to_caps" Input's property. If omitted, the value of the property is preserved. If an implementation doesn't support the property, this query parameter is always ignored.
Example:
true
Body
Media type: application/octet-stream
Type: file
HTTP status code 204
Returns when success.
HTTP status code 400
Returned when the Base EDID is rejected due to validation failure.
Body
Media type: application/json
Type:
{
"$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 Input ID does not exist.
Body
Media type: application/json
Type:
{
"$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 405
Returned when the Input doesn't support Base EDID or doesn't support EDID at all.
Body
Media type: application/json
Type:
{
"$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 423
Returned when the Base EDID can't be applied temporarily due to Device restrictions (e.g. if the Sender is active).
Body
Media type: application/json
Type:
{
"$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 if the Base EDID can't be applied due to a reason not listed above.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
delete /inputs/{inputId}/edid/base
Remove Base EDID
URI Parameters
- inputId: required(string)
HTTP status code 204
Returns when success.
HTTP status code 404
Returned when the requested Input ID does not exist.
Body
Media type: application/json
Type:
{
"$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 405
Returned when the Input doesn't support Base EDID or doesn't support EDID at all.
Body
Media type: application/json
Type:
{
"$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 423
Returned when the Base EDID can't be reset temporarily due to Device restrictions (e.g. if the Sender is active).
Body
Media type: application/json
Type:
{
"$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 if the Base EDID can't be reset due to a reason not listed above.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Redirects to the location of the Effective EDID file or returns the Effective EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the Effective EDID file directly ensure that the Content-Type entity header is correctly set.
get /inputs/{inputId}/edid/effective
Redirects to the location of the Effective EDID file or returns the Effective EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the Effective EDID file directly ensure that the Content-Type entity header is correctly set.
URI Parameters
- inputId: required(string)
HTTP status code 200
The Effective EDID file itself.
Body
Media type: application/octet-stream
Type: file
HTTP status code 204
The Input does not support EDID.
HTTP status code 307
A temporary redirect to the Effective EDID file.
HTTP status code 404
Returned when the requested Input ID doesn't exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Outputs
get /outputs
HTTP status code 200
List of Outputs. All UUIDs are appended with / to indicate that the ID forms part of the URL for the next layer down.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "List of UUIDs",
"title": "List of resources",
"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}/$"
},
"uniqueItems": true
}
Example:
[
"c72cca5b-01db-47aa-bb00-03893defbfae/",
"171d5c80-7fff-4c23-9383-46503eb1c63e/",
"a2655c48-8a46-4c82-b9bc-98760d59d7f8/"
]
List all the API endpoints for a single Output.
get /outputs/{outputId}
List all the API endpoints for a single Output.
URI Parameters
- outputId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"description": "Describes the Stream Compatibility Management API /inputs/{inputId} and /outputs/{outputId} base resource",
"title": "Stream Compatibility Management API /inputs/{inputId} and /outputs/{outputId} base resource",
"items": {
"type": "string",
"enum": [
"edid/",
"properties/"
]
},
"minItems": 2,
"maxItems": 2,
"uniqueItems": true
}
Example:
[
"edid/",
"properties/"
]
HTTP status code 404
Returned when the requested Output ID does not exist.
Return properties of the Output.
get /outputs/{outputId}/properties
Return properties of the Output.
URI Parameters
- outputId: required(string)
HTTP status code 200
Returned when success.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes an Output",
"title": "Output resource",
"allOf": [
{ "$ref": "resource_core.json" },
{
"type": "object",
"required": [
"connected",
"edid_support",
"status",
"device_id"
],
"properties": {
"connected": {
"description": "Whether the downstream counterpart of this Output is connected",
"type": "boolean"
},
"edid_support": {
"description": "Whether the Output supports EDID",
"type": "boolean"
},
"status": {
"description": "Status of Output",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"no_signal",
"default_signal",
"signal_present"
]
},
"debug": {
"description": "Debug information which may give additional information on the state",
"type": "string"
}
}
},
"device_id": {
"description": "Device ID which this Output forms part of",
"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}$"
}
}
}
]
}
Example:
{
"id": "171d5c87-7fff-4c53-9383-46503eb1c23e",
"version": "1441704616:592733242",
"label": "Display 1",
"description": "Display placed on the table in the kitchen",
"device_id": "8ff471c6-bf77-51b1-92e7-939d18d82802",
"tags": {},
"connected": true,
"edid_support": true,
"status": {
"state": "signal_present"
}
}
HTTP status code 404
Returned when the requested Output ID does not exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}
Redirects to the location of the EDID file or returns the EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the EDID file directly ensure that the Content-Type entity header is correctly set.
get /outputs/{outputId}/edid
Redirects to the location of the EDID file or returns the EDID file directly. Check HTTP response code to determine which mode of operation is in use. When returning the EDID file directly ensure that the Content-Type entity header is correctly set.
URI Parameters
- outputId: required(string)
HTTP status code 200
The EDID file itself will be served
Body
Media type: application/octet-stream
Type: file
HTTP status code 204
The Output does not support EDID or the downstream counterpart of this Output does not provide EDID.
HTTP status code 307
A temporary redirect to the EDID file.
HTTP status code 404
Returned when the EDID file or the requested Output ID doesn't exist.
Body
Media type: application/json
Type:
{
"$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"]
}
}
}