Skip to main content
Version: 8.4

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.

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

On success returned.

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.

  • ]
Loading...