This section describes the necessary parameters and data types for REST connector calls.
- pathParams (optional): a sequence defining ordered list of path segments added to Rest endpoint.
- Exp.: {(“pathParams[0]”: “add”, “pathParams[1]”: “to”, “pathParams[2]”: “path”)} will add the path segments “add/to/path” to the endpoint.
- postBody (optional): a JSON defining the post body. If postFormat PLAIN is selected, a string JSON representation of the key/value list will be sent to the REST Endpoint
- *optional postFormat: format and Content-Type of postBody to be sent to REST Endpoint. Possible values are :
- JSON: Json format
- PLAIN: Plain text format
- FORM: URL encoded format
- XML: xml format
- verb: REST Verb with possible values :
- GET
- POST (postFormat is mandatory)
- DELETE
- PUT (postFormat is mandatory)
- PATCH (postFormat is mandatory)
- OPTION
- HEAD
- headParams (optional): key/value object defining additional headers of the REST Request. Any head parameters concerning possible authentication will be added, regardless of any earlier definition by headerParams feature.
- queryParams (optional): key/value object defining query path parameter added to the REST endpoint
Connector execute result
When the connector is executed, it will only return a JSON as a result, if the content-type of the http result is “application/json”. In all other cases, the connector will return a JSON object with the following keys:
- RESTBinaryResult – with the BASE64 encoded result body
- RESTTextResult (returns only if it can be displayed as text)
- Content-Type – mime type of result body
Configuring Output Parameters
For testing purpose, make sure you define at least the root output with a / (slash)
To use advanced features of our rest connector, you can add additional configuration parameters
Parameter | Description | Possible Values | Default Value |
configuration/http/verbosity/ |
Defines the verbosity of the received Http-Headers | Quiet – No information will be returned Normal – The minimal required amount of information will be returned. Verbose – The information will be presented in a non-compact way and more information will be returned. Very-Verbose Even more information will be returned. Debug All possible information will be returned. |
Quiet |
configuration/http/verbosity/ |
Defines the verbosity of the received Content-Type. | Quiet – No information will be returned Normal – The minimal required amount of information will be returned. Verbose – The information will be presented in a non-compact way and more information will be returned. Very-Verbose Even more information will be returned. Debug All possible information will be returned. |
Quiet |
configuration/http/verbosity/ |
Defines the verbosity of the received status-code | Quiet – No information will be returned Normal – The minimal required amount of information will be returned. Verbose – The information will be presented in a non-compact way and more information will be returned. Very-Verbose Even more information will be returned. Debug All possible information will be returned. |
Quiet |
Body Representation
Parameter | Description | Possible Values | Default Value |
configuration/http/body/ |
Defines how the binary result should be returned. The Default is Base64 | Base64 – The binary result will be returned as Base64 with Linebreaks according to RFC-2045.
Signed – The binary result will be returned in an array consisting of integeres from -127 to 127. Unsigned – The binary result will be returned in an array consisting of integeres from 0 to 255. Unsigned-String – The binary result will be returned in a string consisting of integeres from 0 to 255. Hex – The binary result will be returned in an array consisting of strings of pairs of hexa-decimal characters (0-9, A-F). Hex-String – The binary result will be returned in a string consisting of strings of pairs of hexa-decimal characters (0-9, A-F). |
Base64 |