Skip to main content
Version: 8.5

Save draft variables

POST 

/v1/tasks/:taskId/variables

This operation performs several actions:

  1. Validates the task and draft variables.
  2. Deletes existing draft variables for the task.
  3. Checks for new draft variables. If a new variable's name matches an existing one but the value differs, it is saved. In case of duplicate draft variable names, the last variable's value is kept.
NOTE:
  • Invoking this method successively will overwrite all existing draft variables. Only draft variables submitted in the most recent request body will be persisted. Therefore, ensure you include all necessary variables in each request to maintain the intended variable set.
  • The UI does not currently display the values for draft variables that are created via this endpoint.

Request

Path Parameters

    taskId stringrequired

    The ID of the task.

Body

required
    variables object[]

    Variables to update or add to the task.

  • Array [
  • name string

    The name of the variable.

    value string

    The value of the variable. When specifying the variable value, it's crucial to maintain consistency with JSON values (serialization for the complex objects such as list) and ensure that strings remain appropriately formatted.

  • ]

Responses

On success returned.

Schema
    any
Loading...