evaluateArcade

POST
1
/{orgId}/{itemId}/evaluateArcade

Arcade 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:

ParameterDescriptionData Type
expressionRequired. Define the arcade expression you want to evaluateString
contextTypeRequired. Define the context of the expression. BaseContext is used for the user context. JobContext can also be specified for job specific properties.String
contextOptional depending on contextType. Required for JobContext. 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
parseModeOptional. 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

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDefault valueDescription

An arcade expression evaluator object defining the context type and the jobId to be evaluated.

context

object

» jobId

string

expression

string

string

string

body

An arcade expression evaluator object defining the context type and the jobId to be evaluated.

parseMode

undefined

Enumerated values
Standard
URL
Query

contextType

undefined

Default
JobContext
Enumerated values
BaseContext
JobContext

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

1
2
3
4
5
6
# 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

StatusMeaningDescriptionSchema

200

OK

Dynamic value based on the expression during execution.

ArcadeExpressionResult

500

Internal Server Error

error

WorkflowJsonExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close