Search task variables

POST 
/v1/tasks/:taskId/variables/search

This method returns a list of task variables for the specified taskId and variableName.
If the request body is not provided or if the variableNames parameter in the request is empty, all variables associated with the task will be returned.

Request

Path Parameters

taskId stringrequired

The ID of the task.

application/json

Body

variableNames string[]

Names of variables to find.

includeVariables object[]
An array of variable names that should be included in the response.
Array [
name string
The name of the variable.
alwaysReturnFullValue boolean
Always return the full value of the variable?
]

Responses

200

On success returned.

application/json

Schema

Schema

• Array [
id string

The unique identifier of the variable.

name string

The name of the variable.

value string

The value of the variable.

isValueTruncated boolean

Does the previewValue contain the truncated value or full value?

previewValue string

A preview of the variable's value. Limited in size.

draft object

The draft value of the variable.

value string

The value of the variable.

isValueTruncated boolean

Does the previewValue contain the truncated value or full value?

previewValue string

A preview of the variable's value. Limited in size.

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "value": "string",
    "isValueTruncated": true,
    "previewValue": "string",
    "draft": {
      "value": "string",
      "isValueTruncated": true,
      "previewValue": "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 (eg. in log messages).

Example (from schema)

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

Loading...