Page History

...

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
shouldDisplayInlineCommentsInIncludes	false

Attribute	Type	Description	Allowed 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.	a valid host, e.g. scheer-acme.com
port	Integer	Overwrite here the port through which the REST service is accessible.	a valid port number, e.g. 12345
protocol	String	Overwrite here the protocol through which the REST service is accessible.	http

...

	Use the HTTP protocol to access the service (default).
https	Use the HTTPS protocol to access the service.
ignoreHttpErrors	Boolean	If true, Default value is true.	true	HTTP error codes >= 400 will not cause an exception in the

...

service (default). This implies, that the response body is accessible even if HTTP errors occur.

...

false	HTTP error codes >= 400 will cause an exception in the service.
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.	Valid composer options as described below.

AdapterResponse

Attribute	Type	Description	Values/Example
httpStatus	Integer	HTTP status code of the adapter call.	500
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	Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map. Header names are lowercase and treated case insensitive. Multiple headers with the same name are treated as arrays. Refer to HTTP Header Support for more information on the standard xUML HTTP headers.

Request and Response Types

Multiexcerpt

MultiExcerptName	Request_and_Response_Types
shouldDisplayInlineCommentsInIncludes	false

REST Type	Attribute	Type	Description	Allowed Values/Example
Authentication	username	String

...

Specify a username.
password	String

...

Specify a password.

Anchor

	Certificate
	Certificate

Certificate

file

String

...

Provide name of a certificate file.
type	String

...

Specify the type of the certificate file. One of PEM or DER.

Anchor

	ComposerOptions
	ComposerOptions

ComposerOptions

jsonKeepNulls

Boolean

Specify the handling of NULL values.

true

...

Keep NULL values during JSON composing.

...

false Do not serialize NULL values during JSON composing.

jsonCompact Boolean Specify the generated JSON format. true Serialize to JSON without pretty-printing.

false Produce a pretty JSON.

jsonWriteTypeDiscriminator Boolean Specify whether to write type information to the generated JSON. true Write a type discriminator to the generated JSON.

false Do not write a type discriminator to the generated JSON.

Entry key String Specify the key of a map entry.

value Array of Any Provide a list of values of the map entry. The dynamic type for httpHeaderMap is String.

HTTPMethod enumeration Can be one of the listed HTTP methods. DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT

HeaderField name String Specify the name of the header field.

value String Provide a header value.

Anchor

	Ke<
	Ke<

Key

file

String

Specify the name of the file that contains the private key.

type String Specify the type of the private key.

password String Specify the password for the private key.

Anchor

	Option
	Option

Option

name

String

Specify the name of the cURL option.

value String Provide a value.

Parameter name String Specify the name of the parameter.

value String Provide a value.

Anchor

	Proxy
	Proxy

Proxy

url

String

Specify a URL to the proxy server.

A valid URL.

type String Specify a proxy type HTTP The proxy is a HTTP proxy.

SOCKS5 The proxy is a SOCKS5 proxy.

authentication Authentication See above.

Anchor

	SSL
	SSL

SSL

verifyPeer

String

Specify whether to verify the peer information from the SSL connection.

true

Verify the peer information (default).

false Do not verify the peer information.

verifyHost String Specify whether to verify the host information from the SSL connection. On Verify the host information (default).

Off Do not verify the host information.

Existence Only check for existence of the host.

caInfo String Specify the name of the file that contains additional certificates for the connection verification.

certificate Certificate Specify the certificate information (see above).

key Key Specify the private key information (see above).

...

Page tree

Versions Compared

Old Version 14

New Version 15

Key

RequestOptions

AdapterResponse

Request and Response Types