Versions Compared

Old Version 19

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version 20

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WDESIGNER and version 23.2

...

REST Parameter Types

AdapterResponse

Multiexcerpt
MultiExcerptNameAdapterResponse
AttributeTypeDescriptionAllowed Values / Examples
httpStatusIntegerHTTP status code of the adapter call.500
headers
Array of HeaderField

...

Note
iconfalse

DeprecatedThis attribute is deprecated. It is only present for compatibility reasons.

Please use httpHeaderMap (see below) for new implementations. The implementation of httpHeaderMap complies to the HTTP specification and supports multiple headers having the same name.


bodyBlob

HTTP body of HTTP response.

...

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.

Among others, the body contains

  • the response Object for successful calls
  • an object of the RESTError class if the call has not been successful.

responseObjectAny

Response Object of the REST adapter call if the endpoint returns one (response output parameter).

Info

The response object is only returned for successful calls.


httpHeaderMapMap of EntryHeader 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

AttributeTypeDescriptionAllowed Values / Examples
queryStringStringQuery string, if provided with the call.status=in%20progress
queryParametersArray of ParameterAll query parameters as an array of Parameter classes containing name/value pairs.
bodyBlobBody of the HTTP request.
pathStringPath to the REST resource./support/supportcases/
pathParametersMapAll REST parameters as a map.
httpHeaderMapMap 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.


...

AttributeTypeDescriptionAllowed Values / Examples
headersArray of HeaderFieldAll HTTP response header fields as an array of HeaderField classes containing name/value pairs.
statusCodehttpCodeIntegerThe resulting HTTP status code. If not set explicitly using this object, the service returns 200 if no exception occurred, or 500 otherwise.404
errorObjectresponseObjectAnyResponse Object of the type defined with stereotype RestErrorREST adapter call if the endpoint returns one (response output parameter).


Request and Response Types

...