Page History

...

Multiexcerpt

MultiExcerptName	REST_Parameter_Types

Request

Attribute Type Description Values/Example

method HTTPMethod HTTP method used in call. GET

headers

Array of HeaderField

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaders_depr
PageWithExcerpt	INTERNAL:_bridge_excerpts

All HTTP request header fields as an array of HeaderField classes containing name/value pairs. The header fields contain the standard HTTP headers as well as header parameters, if provided.

queryString String Query string, if provided with the call. status=in%20progress

queryParameters Array of Parameter All query parameters as an array of Parameter classes containing name/value pairs.

body Blob Body of the HTTP request.

path String Path to the REST resource. /support/supportcases/

pathParameters Map All REST parameters as a map.

httpHeaderMap

Map of Entry

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaderMap
PageWithExcerpt	INTERNAL:_bridge_excerpts

Response

Attribute	Type	Description	Values/Example
headers	Array of HeaderField	All HTTP response header fields as an array of HeaderField classes containing name/value pairs.
statusCode	Integer	The resulting HTTP status code. If not set explicitly using this object, the service returns 200 if no exception occurred, or 500 otherwise.	`404`
errorObject	Any	Object of the type defined with stereotype <<RESTError>>.

RequestOptions

Multiexcerpt

MultiExcerptName	RequestOptions

Attribute	Type	Description	Values/Example
additionalHeaders	Array of HeaderField	All REST request header fields as an array of HeaderField classes containing name/value pairs.
options	Array of Option	Specify native cURL options as listed in Setting cURL Options on the URL Adapter . Use one of the following syntax rules: values separated by `','` in one line values separated by `' '` in one line list of tagged values
ssl	SSL	Use this parameter to supply SSL information.
proxy	Proxy	Use this parameter to supply necessary proxy information.
additionalQueryParameters	Array of Parameter	Use this parameter to provide additional query parameters to the REST service call.
followRedirects	Integer	Specify here the maximum number of redirects to follow.	any integer
basicAuth	Authentication	This parameter provides an object of type Authentication containing the user and the password.
basePath	String	Overwrite here the base path of the REST service.	a valid path, e.g. `/support`
host	String	Overwrite here the host running the REST service that has been defined in the component diagram.
port	Integer	Overwrite here the port through which the REST service is accessible.
protocol	String	Overwrite here the protocol through which the REST service is accessible.	http, https
ignoreHttpErrors	Boolean	If true, HTTP error codes >= 400 will not cause an exception in the model. This implies, that the response body is accessible even if HTTP errors occur. Default value is true.	true / false
jsonComposerOptions	ComposerOptions	Use this parameter to specify JSON composer options on the REST call. You can use these options to e.g. overwrite jsonKeepNulls from the REST alias.

AdapterResponse

Multiexcerpt

MultiExcerptName	AdapterResponse

Attribute

Type

Description

Values/Example

httpStatus

Integer

HTTP status code of the adapter call.

500

headers

Array of HeaderField

HTTP headers of HTTP response.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaders_depr
PageWithExcerpt	INTERNAL:_bridge_excerpts

HTTP headers of HTTP response.

body

Blob

HTTP

body

Blob

HTTP body of HTTP response.

responseObject

Any

Response Object of the REST adapter call.

If the adapter had an error, the responseObject is an <<RESTError>> class. It could be the default error class or a specific error class dependent on the <<RESTResponseDefinition>> dependencies and the HTTP status code.
If the adapter call had no error, the responseObject is the same as the response output parameter.

httpHeaderMap

Map of Entry

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaderMap
PageWithExcerpt	INTERNAL:_bridge_excerpts

Request and Response Types

REST Type	Attribute	Type	Description	Values/Example
Authentication	username	String	Username.
Authentication	password	String	Password.
Certificate	file	String	Certificate file.
Certificate	type	String
ComposerOptions	keepNulls	Boolean	Keep `NULL` values during JSON composing.
Entry	key	String	Key of the map entry.
Entry	value	Array of Any	List of values of the map entry. The dynamic type for httpHeaderMap is String.
HTTPMethod		enumeration	List of all valid HTTP methods	`DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT`
HeaderField	name	String	Name of the header field.
HeaderField	value	String	Value of the header field.
Option	name	String	Name of the option.
Option	value	String	Value of the option.
Parameter	name	String	Name of the parameter.
Parameter	value	String	Value of the Parameter.
Proxy	url	String	URL.	A valid URL.
	type	String
	authentication	Authentication	See above.
SSL	verifyPeer	String
	verifyHost	String
	caInfo	String
	certificate	Certificate	See above.
	key	Key

Page tree

Versions Compared

Old Version 9

New Version 10

Key

Request

Response

RequestOptions

AdapterResponse

Request and Response Types