Start | Advanced API documentation

Start

GET /sequence/start

Start sequence. This requires the sequencer to be initalized, which can be achieved by opening the tab once.

Query parameters

skipValidation boolean

Skip validation of the sequence

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response string
- Error string
- StatusCode integer
- Success boolean
- Type string
409 application/json

Sequence not initialized / Sequence 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/start

curl \
 --request GET 'http://localhost:1888/v2/api/sequence/start'

Response examples (200)

{
  "Response": "Sequence started",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}

Response examples (409)

{
  "Response": "string",
  "Error": "Sequence is not initialized",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}

Response examples (500)

{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}