Input Commands

Data controllers are also referred to as inputs and/or profiles. called an input. These commands allow you to creating, modify, and attach profiles and data controllers.

getProfileList

get

Read the profile information for all inputs..

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/getProfileList HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "getProfileList",
    "inputs": [
      {
        "name": "Google: Sheets.Sheet 1"
      }
    ],
    "profiles": [
      {
        "name": "Google: Sheets.Sheet 1"
      }
    ],
    "reply": "getProfileList",
    "success": true
  }
}

setTitleInput

get

Assign an input to the title.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Example: Test

inputstringOptional

optional: Input name, used to select the title(s) to operate on

Example: inputName

mergestringOptional

when 1, the new input will be combined with existing inputs on the title

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setTitleInput HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setTitleInput",
    "reply": "setTitleInput",
    "success": true
  }
}

attachProfile

get

Connects a specific input profile to a title. It works exactly like setTitleInput except this command allows you to use 'input' to find a title by input while that one reuires the use of title name/id.

Because this endpoint doesn't use any variables, it can also be accessed using a GET request.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}

titlestringOptional

optional: Name (or UUID) of the title to operate on.

inputstringOptional

optional: Input name, used to select the title(s) to operate on

mergestringOptional

set to 1 to merge the new input with existing inputs

profilestringOptional

Name of profile (data controller) to add to the found title(s)

Example: Test: Profile Name

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/attachProfile HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "attachProfile",
    "error": "title not found",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "attachProfile",
    "success": true
  }
}

changeInputName

get

Renames an input controller.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

inputstringOptional

Name of input / profile to change.

Example: Test: Input Name 1

newNamestringOptional

New name to assign to it.

Example: Test: Dog Walker Mark 5

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/changeInputName HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "changeInputName",
    "error": "unknown command",
    "reply": "changeInputName",
    "success": true
  }
}

setProfile

get

Creates an input dynamically at runtime. The profile field must contain the full XML of an input. After creating an input, you can then assign it to a title by name using the attachProfile command. NOTE: This function can only be used through the scheduleCommandXml API as shown below:

Because this endpoint doesn't use any variables, it can also be accessed using a GET request.

Query parameters

profilestringOptional

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setProfile HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setProfile",
    "error": "Invalid profile data.",
    "reply": "setProfile",
    "success": true
  }
}

NOTE: setProfile requires submitting xml data, so to use it, unless your xml data is small, you might need to send it as a POST request to the /api/ endpoint directly.