This plugin consumes a REST Web Service and optionally captures the response as a list, record, or value.
Endpoint URL
Specify a REST endpoint. Internal endpoint URL's you've defined previously are suggested in the dropdown.
Method
Specify the HTTP method or verb to use for this request.
Headers
Provide HTTP headers in the form of a JavaScript object.
Body
Specify the request body as a valid JavaScript expression or object.
Use JSON
When checked, the body must be a JSON-serialized object, and the content type will be set to 'application/json'.
Auth
An object containing one or more of these values:
- user || username
- pass || password
- sendImmediately
- bearer
Capture response?
Check this box to capture the Web Service response into a variable or property.
Capture response on error?
By default, the response is only captured for successful HTTP status codes (codes from 100-399.) Check this box to capture the response for errors such as 4xx and 5xx status codes.
Capture as
Variables and properties are tracked as either lists, records, or simple values. Specify the proper context for capturing the results of this REST call.
Capture Specific Property
You can capture the entire Web Service response, or just a specific property. If you would like to capture a specific property, provide it here.
For example:
customerRecord
or
customerRecord.orders
Where do you want to place the response?
The response can be placed on the screen, into a grid, into a work variable, or into a property.
Enter work variable name
A work variable is accessible by other steps within the same routine. Some work variables, like 'activeGridRecord' are implied and don't have to be explicitely defined by you.
Enter API output property name
The API output object represents the data sent in response to the API request.