RESTCaller Operations

PUT

Sends an HTTP PUT request to the rest service URL. Generally used for creating the addressed resource.

Arguments:

restUrl
options
params
bodyXML

Options that apply:

returnAllHttpCodes
copyResultsAsText
responseConversion
sendAsJSON
sendAsText
sendParamsAsFormData
sendThisContentType
authorizationType
httpAuthorization
returnJSONTypeHints
httpHeaders
preserveJSONEscapes

Note: HTTP PUT commands are often blocked by outbound firewall policies; therefore, ensure you have access through the firewall before the orchestration workflow executes a PUT command.

GET

Sends an HTTP GET request to the rest service URL. Generally used for retrieving the addressed resource, but some services may use GET for other purposes as well.

Arguments:

restUrl
options
params

Options that apply:

returnAllHttpCodes
copyResultsAsText
responseConversion
authorizationType
httpAuthorization
returnJSONTypeHints
httpHeaders
preserveJSONEscapes

POST

Sends an HTTP POST request to the rest service URL. Generally used for updating the addressed resource.

Arguments:

restUrl
options
params
bodyXML

Options that apply:

returnAllHttpCodes
copyResultsAsText
responseConversion
sendAsJSON
sendAsText
sendParamsAsFormData
sendThisContentType
authorizationType
httpAuthorization
returnJSONTypeHints
httpHeaders
preserveJSONEscapes

DELETE

Sends an HTTP DELETE request to the rest service URL. Generally used for deleting the addressed resource.

Arguments:

restUrl
options
params

Options that apply:

returnAllHttpCodes
authorizationType
httpAuthorization
httpHeaders

Note: HTTP DELETE, PUT, and PATCH commands are often blocked by outbound firewall policies; therefore, ensure you have access through the firewall before the orchestration worklow executes these commands.

Another workaround is to use an alternate HTTP header such as X-HTTP-Method-Override: PATCH, X-HTTP-Override, or X-Method-Override. Whether these headers work or not depends on the framework that implements the REST service.

HEAD

Returns the headers that result from GET but does not return the resource.

For more information, visit https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

OPTIONS

Returns information about methods the resource supports, typically with an Allow header that lists the operations. Request and response body data is optional.

For more information, visit https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

PATCH

Allows partial updates of resources.

For more information, visit https://tools.ietf.org/html/rfc5789.

TRACE

Returns the sent message as it is received.

For more information, visit https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.