Breadcrumbs

REST Service Reference


Tagged Values


There were errors rendering macro:

  • An unknown error occurred.


<<RESTAlias>>


There were errors rendering macro:

  • An unknown error occurred.


REST Content Types

The Bridge handles content types as follows:


  • If the Content-Type header is set, the Bridge will assume that the request is of that type. All other request will be rejected (HTTP error code 406).

  • If no Content-Type header is set, but the Accept header is, the Bridge will deduce the request type from it. All other request will be rejected (HTTP error code 406).
    To determine the format, the Bridge will take into account the quality factor and the order of the accept headers list.

  • In absence of both headers, the Bridge will assume JSON. All other request will be rejected (HTTP error code 415).

The full matching is done in a "best effort" manner. Given the type format <type>/<subtype>[+<suffix>][; paramName=paramValue]*, the Bridge first disregards the type and parameters. Then it checks, if the subtype is JSON or XML. If the subtype doesn't match with the supported types, it tries the suffix.


REST Adapter Parameters


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.


REST Utility Functions


Access to HTTP request and response objects is provided through global methods: getRestHttpRequest()and getRestHttpResponse().

Function

Parameter

Return Value

Description

Example

getRestHttpRequest()

none

object of type Request

Returns the request details as provided by the HTTP call. Changing the request object will not have any effects.

local request = getRestHttpRequest();

getRestHttpResponse()

none

object of type Response

Set the response details to return them to the caller.

local response = getRestHttpResponse();


Error rendering macro 'multiexcerpt' : Page loading failed



REST Parameter Types


There were errors rendering macro:

  • An unknown error occurred.



Related Pages: