Web request evaluator
Evaluates the response from the HTTP request configured in the Send Web Request step. The evaluator can be used to ensure correct responses as well as proper step configuration before running the step in a job. Properties used will vary depending on the API. A valid jobId is required to evaluate Arcade expressions. The adminBasic or adminAdvanced privilege is required.
Web request evaluator parameters:
| Parameter | Description | Data Type |
|---|---|---|
| requestType | Required. Can be set to GET, POST, PUT, DELETE, HEAD, PATCH, or OPTIONS. | String |
| baseUrl | Required. The URL of the REST endpoint to send the request to. | String |
| queryParams | Optional. Add a Key and Value for each query parameter. | String |
| pathParams | Optional. Add a Key and Value for each path parameter. | String |
| headers | Optional. Add a Key and Value for each header. | String |
| body | Optional. Can be set to Form Data, URL Encoded, or Raw. If Form Data or URL Encoded, add a Key and Value for each entry. If Raw, add content and contentType, either JSON or String. | String |
| authorization | Optional. Can be set to No Auth, API Key, Bearer Token, Basic Auth, or Digest Auth. If API Key, add a Key and Value for each entry and specify whether to add them to Headers or Query Parameters. If Bearer Token, add a token. If Basic Auth or Digest Auth, add a username and password. | String |
| attachment | Optional. Requires the Workflow Manager Advanced license. Enter a custom folder name or attachment name. | String |
| outputValues | Optional. Requires the Workflow Manager Advanced license. Add a Key and Value. The Value will be the JSON Path for the desired output value. | String |
| jobId | Optional. A valid JobId is required if using this property. Required to evaluate Arcade expressions. | String |
Body parameter
{
"webRequest": {
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
},
"authorization": {
"apiKey": {
"key": "string",
"value": "string",
"addedTo": "QueryParams"
},
"credentials": {
"username": "string",
"password": "string",
"token": "string"
},
"authorizationType": "NoAuth",
"tokenRequest": {
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": null
},
"urlEncoded": {
"keyValues": null
},
"raw": {
"content": null,
"contentType": null
}
},
"authorization": {
"apiKey": {
"key": null,
"value": null,
"addedTo": null
},
"credentials": {
"username": null,
"password": null,
"token": null
},
"authorizationType": "NoAuth",
"tokenRequest": {
"requestType": null,
"baseUrl": null,
"queryParams": null,
"pathParams": null,
"headers": null,
"body": null,
"authorization": null,
"attachment": null,
"outputValues": null
}
},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"jobId": "string"
}Query parameters
| Name | Type | Required |
|---|---|---|
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/evaluateWebRequest \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Response
200 Response
{
"status": 0,
"body": "string",
"requestUrl": "string",
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"outputs": {
"outputs": [
{
"value": "string",
"name": "string",
"dataType": "string",
"isEncoded": true
}
],
"returnValue": "string",
"isUserSpecifiedReturnValue": true,
"comment": "string"
}
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| success | ||
| error |