Load Sequence from file

GET /sequence/load

Loads a sequence from a file from the default sequence folders, the names can be retrieved using the sequence/list-available endpoint

Query parameters

  • sequenceName string Required

    The name of the sequence to load

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Sequence not initialized or already running

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

      Values are Sequence is not initialized or Sequence is already running.

    • 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/load
curl \
 --request GET 'http://localhost:1888/v2/api/sequence/load?sequenceName=Orion'
Response examples (200)
{
  "Response": "Sequence updated",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (400)
{
  "Response": "string",
  "Error": "Sequence is not initialized",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500)
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}