Advanced API

Complete Sequence

GET /sequence/state

Get sequence as json. This is similar to the json endpoint, however the returned sequence is much more elaborate and also supports plugins. The returned json from /json is not directly compatible with this endpoint. Use this endpoint (not json!) as reference for sequence editing! In general however I recommend using the json endpoint as it gives more reliable results, so use this if you do not need the extra functionality.

Responses

  • 200 application/json

    Successful response, best to try it out yourself

    Hide response attributes Show response attributes object
    • Response array[object]
      One of:
      object-1 object object-2 object
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Sequencer not initialized

    Hide response attributes Show response attributes object
    • Response string
    • Error string

      Value is Sequencer not initialized.

    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /sequence/state 
curl \
 --request GET 'http://localhost:1888/v2/api/sequence/state'
Response examples (200) 
{
  "Response": [
    {
      "Conditions": [],
      "Items": [],
      "Triggers": [],
      "Status": "string",
      "Name": "string"
    }
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Sequencer not initialized",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}