operation
Summary​
Performs an API operation defined within a configured API
Description​
This action depends on a configured API in order to use it. The user will choose from an API operation and the action will provide input based on the definition.
Fields​
apiOperationReference​
The API Operation to perform.
url​
The URL as a string pattern with variables {protocol}://{host}:{port}.
variables​
The variables to be injected into the URL pattern.
body​
The request body which will automatically be JSON encoded.
header​
The request headers as an object.
query​
The request queries as an object.
decode-body​
Select whether the response body should be JSON decoded or not.
timeout​
Returns an error if the result does not progress within 'Timeout'.
onError​
This will be performed only if there is a protocol related error such as connectivity issues or timeouts. The 'error' scope will include type and message. The result of this handler will replace the error result of this action.
stopOnError​
This will determine whether the execution should stop after a protocol related error. This will effectively reraise the original error after any onError handler.
onErrorCode​
This will be performed only if the response status code is not in the 200 suite. The 'error' scope will include the http response. The result of this handler will replace the error result of this action.
stopOnErrorCode​
This will determine whether the execution should stop after a status code outside the 200 suite. This will raise an error with a simple HTTP error message.