Advanced API

Edit a Sequence

GET /sequence/edit

This works similary to profile/set-value. Note that this mainly supports fields that expect simple types like strings, numbers etc, and may not work for things like enums or objects (filter, time source, ...). This is an experimental feature, and it could have unexpected side effects or simply not work for some instructions or fields. If you encounter any bugs (except that it is not working with enums or objects), feel free to create an issue on github or contact me on the NINA discord.

Query parameters

  • path string Required

    The path to the property that should be updated. Use GlobalTriggers, Start, Imaging, End for the sequence root containers. Then use the name of the property or the index of the item in a list, seperated with -. The example would set the exposure time of a Take Exposure instruction, contained in a DSO container, to 20s. Use sequence/state as reference, not sequence/json!

  • value string Required

    The new value

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

    Faulty state

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

      Values are Sequence is not initialized, No DSO Container found, Invalid path, or New value can't be null.

    • 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/edit 
curl \
 --request GET 'http://localhost:1888/v2/api/sequence/edit?path=Imaging-Items-0-Items-0-ExposureTime&value=20'
Response examples (200) 
{
  "Response": "Updated setting",
  "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"
}