GET List: Get a List of Router Inputs - AWS Elemental Conductor Live 3

This is version 3.19 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

GET List: Get a List of Router Inputs

Get the list of all the inputs for the specified router.

HTTP Request and Response

Request URL

GET http://<Conductor IP address>/routers/<ID of router>/inputs

Call Header

  • Accept: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Response

The response is XML content consisting of one inputs element that contains:

  • An HREF attribute that specifies the product and version installed on the AWS Elemental Conductor Live 3 node.

  • Zero or more input elements, one for each input found. Each input element contains several elements.

Element Value Description
id Integer The ID for this input, unique for this router and assigned by AWS Elemental Conductor Live 3 when the input is created.
name String The name for this input.
router_id Integer The router to which this input belongs.
input_number Integer

The ID of the router input corresponding to the physical port on the router. This number is assigned by the router and specified to AWS Elemental Conductor Live 3 by the user (not assigned by AWS Elemental software).

For 4 Quadrant-4k inputs, this is the first input number in a sequence of four.

input_number_end Integer

For 4 Quadrant-4k inputs, the last input number in the sequence of four.

This element is not used if you are not adding 4 Quadrant-4k inputs.

quad True/False It is not necessary to specify if you are not adding 4 Quadrant-4k inputs.

Example

This request is for the inputs associated with the router with the ID 4. The response specifies that there are two inputs in this router with IDs 3 and 4.

GET http://198.51.100.0/routers/4/inputs ---------------------------- Content-type:application/vnd.elemental+xml;version=3.3.0 ---------------------------- <?xml version="1.0" encoding="UTF-8"?> <inputs href="/routers/4/inputs" product="AWS Elemental Conductor Live" version="3.3.nnnnn"> <input> <id>3</id> <name>Input 1</name> <router_id>2</router_id> <input_number>1</input_number> <input_number_end nil="true"/> <quad>false</quad> </input> <input> <id>4</id> <name>Input 2</name> <router_id>2</router_id> <input_number>2</input_number> <input_number_end nil="true"/> <quad>false</quad> </input> </inputs>