Description
Allows you to call a web service that is REST based.
Signature
CallRestAPI(
SetRequestBaseURL('baseurl'),
SetRequestResource('resource'),
SetRequestDetails('method'),
SetRequestHeaders(),
SetRequestParams(),
SetRequestAuthenticationNone(),
SetRequestFiles(),
SetRequestExpected('responsestatuscode'),
SetRequestActionPass('action'),
SetRequestActionFail('action')
)
Example
Use the search function to see examples.
Notes
After the execution of the function several variables are automatically populated from the results of the function. These can be accessed via a GetVar() function call,
e.g. GetVar('responsecontent').
List of available variables :
- ResponseContent
- ResponseStatusCode
- ResponseStatusDescription
- ErrorException
- ErrorMessage
- File
- ResponseUri
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
SetRequestBaseURL |
xxxx | xxxx | xxxx |