POST: Create a Router Input - AWS Elemental Conductor Live 3

This is version 3.17 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.

POST: Create a Router Input

This request creates a new input for the specified router. Use this command repeatedly to set up all the router inputs. The total number of Router Input entities for a specified router must not exceed the max_input on that Router entity: it must not exceed the actual physical inputs on the router.

HTTP Request and Response

Request URL

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

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

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

Request Body

The response is in XML content consisting of one input element, consisting of the following elements.

Element Value Description
name String A name for this input, of your choosing. This name appears in the Inputs drop-down list on the AWS Elemental Conductor Live 3 web interface.
input_number Integer

The ID of the router input that you want to make known to AWS Elemental Conductor Live 3. This is the ID for the input as assigned by the router (not assigned by AWS Elemental software).

When adding 4 Quadrant-4k inputs for HEVC, enter the first input number in the sequence.

input_number_end Integer

When adding 4 Quadrant-4k inputs for HEVC, enter the last (fourth) input number in the sequence.

For example, if you provided “1” for input_number, you would use “4” for input_number_end.

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

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

Response

The response repeats back the data that you posted with the addition of:

  • id: The newly assigned ID for the router_input.

  • router_id: The router that this router input belongs to.

The response is identical to the response to a GET Router Input. See below for an example.

Example

Request

This request is to create a router input for the input that has the router-assigned ID of 1.

POST http://198.51.100.0/routers/2/inputs ----------------------- Content-type:application/vnd.elemental+xml;version=3.3.0 Accept:application/xml ----------------------- <input> <name>Input 1</name> <input_number>1</input_number> </input>

Response

In this example, the router input has been automatically assigned the ID 4. The already existing ID of the router itself is 2.

<input> <id>4</id> <name>Input 1</name> <router_id>2</router_id> <input_number>1</input_number> <input_number_end nil="true"/> <quad>false</quad> </input>