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.

application/json

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

204

On success returned.

*/*

Schema

Schema

any

400

An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before, except the case when JWT authentication token used.
An error is returned if the task is not assigned to the current user, except the case when JWT authentication token used.

application/problem+json

Schema

Schema

status int32

An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.

message string

A string that provides a brief description of the error that occurred.

instance string

Error instance UUID for lookup (e.g., in log messages).

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string"
}

404

An error is returned when the task with the taskId is not found.

application/problem+json

Schema

Schema

status int32

An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.

message string

A string that provides a brief description of the error that occurred.

instance string

Error instance UUID for lookup (e.g., in log messages).

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string"
}

500

An error is returned if an unexpected error occurs while persisting draft task variables.

application/problem+json

Schema

Schema

status int32

An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.

message string

A string that provides a brief description of the error that occurred.

instance string

Error instance UUID for lookup (e.g., in log messages).

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string"
}

Loading...