/{orgId}/{itemId}/evaluateArcadeArcade expression evaluator
Provides results for dynamic properties based on expression that can be evaluated during run time without having to build them into the job template or search. If any of the properties are not defined on the context, the arcade expression evaluator will return an empty result. The job context should be used to evaluate job specific properties, and the base context should be used to evaluate user level properties. The adminBasic or adminAdvanced privilege is required.
Arcade expression evaluator parameters:
| Parameter | Description | Data Type |
|---|---|---|
| expression | Required. Define the arcade expression you want to evaluate | String |
| contextType | Required. Define the context of the expression. Base is used for the user context. Job can also be specified for job specific properties. | String |
| context | Optional depending on contextType. Required for Job. Input the jobId in the context object for which you want to find the dynamic property value defined on the job during run time. | Object |
| parseMode | Optional. Can be set to Standard, URL, or Query. If URL, the returned result will be url encoded. If Query, the returned result will have each value in quotes. | String |
Query parameters
| Name | Type | Required |
|---|---|---|
| |
Body parameters
Supported content types: application/json
| Name | Type | Required | Default value | Description |
|---|---|---|---|---|
An arcade expression evaluator object defining the context type and the jobId to be evaluated. | ||||
| | |||
| | |||
| | |||
| ||||
|
contextType
undefined
- Default
- JobContext
Enumerated values
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/evaluateArcade \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
--data '{"context":{"jobId":"string"},"expression":"string","parseMode":"Standard","contextType":"BaseContext"}'Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| Dynamic value based on the expression during execution. | ||
| error |