Div

Class	e2e-refDiv

Otp

Floating	false

Rp
REST Adapter

Stereotype Attributes

RESTAliasREST Alias

Multiexcerpt

MultiExcerptName	RESTAlias

Attribute
(Name of Setting) Description Allowed Values

Protocol
(protocol) Specify here the protocol through which the REST service is accessible. http, https

Port
(port) Specify here the port through which the REST service is accessible. a valid port

Host
(host) Specify here the host running the REST service. a valid host

Base Path
(basePath)

Specify here the base path of the REST service.

Info
Please note that the base path differs whether you want to access a Designer service from the outside of PAS or from the inside. When you trigger Designer services within the platform, use the part of the path starting with /rest/....

a valid path, e.g

/Idea_Management/rest/process/Idea_management if you want to access a Designer service from outside PAS
/rest/process/Idea_management if you want to access a Designer service from inside PAS

Ignore Http Errors
(ignoreHttpErrors)

Specify here whether you want the REST adapter to throw an exception upon receiving an HTTP error code >= 400.

true

Do not throw an exception upon receiving an HTTP error code >= 400 (default).

false Throw an exception upon receiving an HTTP error code >= 400.

Additional Request Headers
(additionalHeaders) This attribute can contain a list of additional headers in form of name/value pairs. Valid format is: <name>:<value>, e.g. API-Key:acme . Separate multiple headers with a comma.

HTTP Header Role Definitions for Requests
(requestHttpHeaderRoles)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	requestHttpHeaderRoles
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	requestHttpHeaderRoles_adapter
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes

client_host

Provide the client host in a header <http header name>instead of X-Sender-Host.

client_service

Provide the client service in a header <http header name> instead of X-Sender-Service.

correlation_id

Provide the correlation ID in a header <http header name> instead of X-Request-Id.

transaction_id

Provide the transaction ID in a header <http header name> instead of X-Transaction-Id.

passthrough

Pass a present header <http header name> to the called service.

passthrough=<request header name>

Pass an present header <request header name> to the called service under the name of <http header name>.
This is equivalent to renaming a header.

Algorithm
(digestAlgorithm)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	digestAlgorithm
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes
shouldDisplayInlineCommentsInIncludes	false

None

No header generated (default).

MD5

Generate header using MD5 algorithm.

SHA

Generate header using SHA algorithm.

SHA-1

Generate header using SHA-1 algorithm.

SHA-256

Generate header using SHA-256 algorithm.

SHA-512 Generate header using SHA-512 algorithm.

Accepted Count of Redirects to Follow
(followRedirects) Specify here the maximum number of redirects to follow. Default value is 0 (no redirects). any integer, 0 (default)

cURL Options
(options)

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 attributes

Json Keep Null Values
(jsonKeepNulls) When jsonKeepNulls is true, attributes of the REST parameter having NULL values will be provided with the REST call, otherwise they will be left out completely (see also chapter NULL Values). true Render attributes with NULL values to the REST call.

false Leave out attributes with NULL values in the REST call (default).

Json Compact Format
(jsonCompact) When jsonCompact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. true Generate compact JSON (default).

false Generate pretty JSON.

User
(user) Specify credentials here , if the called REST service needs basic authentication. Valid format is <user>/<password>, e.g. david.stringer/pAsWoRd456

Proxy Settings (if the called REST service is accessed via a proxy)

Proxy URL
(proxyURL) Specify the URL of the proxy server. See CURLOPT_PROXY.

Proxy User
(proxyUser) Specify the proxy credentials. See CURLOPT_PROXYUSERPWD, format is <user>/<password>, e.g. david.stringer/pAsWoRd456

Proxy Type
(proxyType) Specify the proxy type. See CURLOPT_PROXYTYPE.

SSL Settings (if the called REST service uses SSL)

SSL CA Info
(sslCAInfo) Specify a file name containing additional certificates for the connection verification (e.g. additional root CAs). See CURLOPT_CAINFO.

SSL Certificate File
(sslCertificateFile) Specify a fle name containing the client certificate. See CURLOPT_SSLCERT.

SSL Certificate Type
(sslCertificateType) Specify the type of the certificate. See CURLOPT_SSLCERTTYPE.

SSL Private Key File
(sslPrivateKeyFile) Specify a file name containing the private key. See CURLOPT_SSLKEY.

SSL Private Key Password
(sslPrivateKeyPassword) Specify the password for the private key. See CURLOPT_KEYPASSWD.

SSL Private Key Type
(sslPrivateKeyType) Specify the type of the key. See CURLOPT_SSLKEYTYPE.

SSL Verify Host
(sslVerifyHost) Specify whether to verify the host information form the SSL connection. See CURLOPT_SSL_VERIFYHOST.

SSL Verify Peer
(sslVerifyPeer) Specify whether to verify the peer information from the SSL connection. See CURLOPT_SSL_VERIFYPEER.

RESTAdapterREST Adapter

Multiexcerpt

MultiExcerptName	RESTAdapter

Attribute
(Name of Setting)

Description

Allowed Values

Alias
(alias)

Specify the REST alias the adapter should connect to.

a valid REST alias

Digest Algorithm
(digestAlgorithm)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	digestAlgorithm
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes
shouldDisplayInlineCommentsInIncludes	false

None

No header generated (default).

MD5

Generate header using MD5 algorithm.

SHA

Generate header using SHA algorithm.

SHA-1

Generate header using SHA-1 algorithm.

SHA-256

Generate header using SHA-256 algorithm.

SHA-512

Generate header using SHA-512 algorithm.

...

REST API

This stereotype defines a package as a REST interfaceport. It has no additional attributes.

REST Resource

Multiexcerpt include

MultiExcerptName	RESTResource
PageWithExcerpt	REST
shouldDisplayInlineCommentsInIncludes	false

REST Operation

Multiexcerpt

MultiExcerptName	RESTResourceREST

Relative Path relativePathDefines path the REST resource or collection in relation to the parent resource. You can provide a static path, or a dynamic path using the notation :<name of a REST Parameter>. You may also provide a combination of both.

Attribute
(Name of Setting)

Description

Allowed Values

Http Method
(

httpMethod)

Provide the

HTTP method of

none

the name of the REST resource will be used, e.g. /supportcases

any valid string

the given name will be used

this REST method should respond to.

a valid HTTP method

GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS

none

method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
GET otherwise

Relative Path
(relativePath)

Defines the path of the REST method in relation to the parent resource.

none

The name of the REST method will be used.

any valid string

The given name will be used. The relative path may also contain variables (REST path parameters, specified as :<variable name>) and can be segmented like e.g. /date=:<a date variable> .

a dynamic path supplying a REST parameter

dynamic path, the value of the REST parameter will be passed to the REST methods, e.g. :id

Is Verbatim Path
(isVerbatimPath)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	isVerbatimPath
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes
shouldDisplayInlineCommentsInIncludes	false

true

Path should be treated as verbatim, path normalization is disabled.

false (default)

Path should be URL encoded.

RESTOperation

Blob Body Content Type
(blobBodyContentType)

Specify a default content type for Blob response parameters from this endpoint. This must be a list of valid Accept headers as defined in RFC 7231.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

Info
This attribute must be left unset if no Blob output parameters are used. In future versions, the effect of this attribute may be extended to other contexts as well.

a list of valid media ranges

e.g. application/msexcel
Default is application/octet-stream if not specified.

Reject Other Response Content Types
(rejectOtherResponseContentTypes)

The xUML Runtime performs a verification of the content-type header for REST responses. Specify whether to return an error (HTTP 406, not acceptable) on responses with a content type that does not conform with the content types specified in Blob Body Content Type.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

true

Reject to perform adapter call if the header "content-type" does not match the values listed in Blob Body Content Type (default).
Exception: RESTLM/48: Request content type not declared as accepted by the service

false Perform the adapter call in spite of content-type header mismatch, and let the service handle this.

Accepted Request Content Types
(acceptedRequestContentType)

Provide a list of content types this REST endpoint accepts

Multiexcerpt

MultiExcerptName	REST

Attribute
(Name of Setting) Description Allowed Values

Http Method
(httpMethod)

Provide the HTTP method of this REST method should respond to.

a valid HTTP method

GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS

none

method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
GET otherwise

Relative Path
(relativePath) Defines the path of the REST method in relation to the parent resource. none The name of the REST method will be used.

any valid string The given name will be used. The relative path may also contain variables (REST path parameters, specified as :<variable name>) and can be segmented like e.g. /date=:<a date variable> .

Is Verbatim Path
(isVerbatimPath)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	isVerbatimPath
PageWithExcerpt	INTERNAL:_designer_excerpts_stereotypes
shouldDisplayInlineCommentsInIncludes	false

true

Path should be treated as verbatim, path normalization is disabled.

false (default) Path should be URL encoded.

Blob Body Content Type
(blobBodyContentType)

Specify a default content type for Blob response parameters from this endpoint

. This must be a list of valid Accept headers as defined in RFC 7231.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

Info
This attribute must be left unset if no Blob output parameters are used. In future versions, the effect of this attribute may be extended to other contexts as well.

a list of valid media ranges

e.g. application/msexcelxhtml+xml
Default is application/octet-stream if not specified.

Reject Other Response Request Content Types
(rejectOtherResponseContentTypesrejectOtherRequestContentTypes)

The xUML Runtime performs a verification of the content-type header for REST responses. Specify whether to return an error (HTTP 406, not acceptable) on responses on requests with a content type that does not conform with the content types specified in Blob Body Accepted Request Content Type.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

true

Reject to perform adapter call if the header "content-typeaccept" does not match the values
listed in
Blob Body
Accepted Request Content Type (default).
Exception: RESTLM/48: Request content type not declared as accepted by the service Set "accept" header does not accept any of declared response content types

false Perform the adapter call in spite of content-type accept header mismatch , and let the service handle this.

Accepted Request Content Types
(acceptedRequestContentType)

Provide a list of content types this REST endpoint accepts. This must be a list of valid Accept headers as defined in RFC 7231.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

Info
This attribute must be left unset if no Blob output parameters are used. In future versions, the effect of this attribute may be extended to other contexts as well.

a list of valid media ranges

e.g. application/xhtml+xml
Default is application/octet-stream if not specified.

Reject Other Request Content Types
(rejectOtherRequestContentTypes)

Specify whether to return an error on requests with a content type that does not conform with the content types specified in Accepted Request Content Type.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.

true

Reject to perform adapter call if the header "accept" does not match the values
listed in Accepted Request Content Type (default).
Exception: Set "accept" header does not accept any of declared response content types

false Perform the adapter call in spite of accept header mismatch and let the service handle this.

RESTParameter

...

MultiExcerptName	RESTParameter

...

REST Parameter

Multiexcerpt include

MultiExcerptName	RESTParameter
PageWithExcerpt	REST

REST Error

The stereotype REST Error is used on a class to mark it as REST error class. Each REST port has a error class assigned that, in case of error, contains additional information. You can get this information using something like

Code Block
create error; set error = adapterResponse.responseObject;

if error is an object of the type indicated by this stereotype.

REST Adapter Parameters

Multiexcerpt

MultiExcerptName	RESTAdapterParameters

Name	Type	Direction	Description
requestOptions	RequestOptions	in	Use this parameter to configure the REST Adapter dynamically and overwrite the settings from the component diagram.
response	Any	out	This parameter holds the adapter output and is of that type that is given back by the called REST service.

...

Page tree

Versions Compared

Old Version 13

New Version 14

Key

Stereotype Attributes

RESTAliasREST Alias

RESTAdapterREST Adapter

REST API

REST Resource

REST Operation

RESTOperation

RESTParameter

REST Parameter

REST Error

REST Adapter Parameters

Page tree

Page History

Versions Compared

Old Version 13

New Version 14

Key

Stereotype Attributes

RESTAliasREST Alias

RESTAdapterREST Adapter

REST API

REST Resource

REST Operation

RESTOperation

RESTParameter

REST Parameter

REST Error

REST Adapter Parameters