VariableSearchResponse

VariableSearchResponse - represents a variable in a search response. It contains information about the variable's ID, name, value, truncation status, and a preview of the value. The value field may be null if the value has been truncated due to exceeding a length limit (8191 characters). The previewValue field provides a shorter preview of the value for display purposes.

Schema

{
  "id": string,
  "name": string,
  "value": string,
  "isValueTruncated": boolean,
  "previewValue": string,
  "draft": {
    "value": string,
    "isValueTruncated": boolean,
    "previewValue": string
  }
}

Example value

{
  "id": "<id>-<var_name>",
  "name": "<var_name>",
  "value": "\"stringVariableValue\"",
  "isValueTruncated": false,
  "previewValue": "\"stringVariableValue\"",
  "draft": {
    "value": "\"draftValueOfVariable\"",
    "isValueTruncated": false,
    "previewValue": "\"draftValueOfVariable\""
  }
}

Fields

VariableSearchResponse.id ● string non-null

id of the variable

VariableSearchResponse.name ● string non-null

variable name

VariableSearchResponse.value ● string non-null

represents the value of the variable. If isValueTruncated is true and alwaysReturnFullValue in the search request is not set to true, the value will be null.

VariableSearchResponse.previewValue ● string non-null

preview of the variable value. It is limited to a length of 8191 characters.

VariableSearchResponse.isValueTruncated ● boolean non-null

indicates, whether previewValue contains truncated value or full value

VariableSearchResponse.draft ● object non-null

represents draft value for variable

Returned by

Search task variables POST  ● 

Member of

TaskSearchResponse object