Search Results

REST Service Binding

REST Binding provides external connectivity for REST over HTTP. You can specify custom HTTP headers and parameters using REST binding. It supports POST, GET, PUT, PATCH, and DELETE HTTP methods. It also supports JSON, XML, and plain text message types.

Binding

This section has the following fields.

Field Description
Resource The name of the resource.
Resource Service Path Specify the path to the Service Resource.

Define parameters in the resource service path by enclosing each parameter in { } brackets. For example, to define the path parameter isbn for a book resource, specify the resource path as follows:

/book/{isbn}

In this example, the client would invoke this service using the URL http:/<host>:<port>/book/<isbn>.

Note: Path parameters that are not immediately enclosed in forward slashes are supported. For example, the parameter authorName('{isbn}') in the resource service path /book/authorName('{isbn}')/ is not directly contained by forward slashes, but will still successfully pass.

If an application contains multiple REST bindings, ensure that the location of the path parameters is unique for each REST binding.

An example is that of one REST binding using the /book/{isbn} path and another REST binding is using the /book/{authorid} path. Since {isbn} and {authorid} are defined at the same location in the URI , one of these services will not function as expected.

In addition to path parameters, the path in a REST binding can also contain query parameters. For example,

/resource/path/{pathparam}? query={queryparam} or /resource/path/{pathparam}?{ queryparam}

HTTP Connector Name The name of the HTTP Connector.
Tip: Click on the HTTP Connector Name field to display details about the HTTP Connector resource.

By default, a new HTTP Connector Shared Resource is created when you create a new REST Service binding. Change the field value type to Module Property to specify a module property that has been defined as an HTTP Connector Shared Resource.

Response Client Format The type of response message format.

The supported response message formats are: JSON or XML.

Enforce BW Service Response Select the check box to set the response preference to BW Service Response.

By default, the check box is not selected, and the response preference is set to the Accept Header response. See, Accept Header Responses, for the REST Service responses based on the Accept Header settings.

Use Empty Values for Null Select the check box to set [] instead of [null] or {} instead of null values in JSON. By default, the check box is not selected.

Operations

This section shows the following details.

Field Description
Name The name of the HTTP method used, for example, POST, GET, PUT, PATCH, and DELETE.
Nickname The specified name of the service, for example, getBooks.

Operation Details

This section shows the following details.

Field Description
Summary This tab has the following available options:
  • Summary: The summary of the REST resource.
  • HTTP Method: Displays the HTTP Method specified in the Operations section. These are the available HTTP methods:
    • POST
    • GET
    • PUT
    • DELETE
    • PATCH
Request Specifies the resource created, using the POST, PUT, or PATCH method. Parameters supported are body, form, query, and header parameters.
Response This tab has the following available options:
  • Use HTTP Headers: Selecting this check box includes the response headers element. Response headers are not commonly used, so select this checkbox only when you need to include response headers.
  • Use Custom Status Line: You can specify a custom status line (status code and reason phrase) to the outgoing message. The codes used must be defined in the configuration under the Response Status tab.
  • Response with Status Code Only: The operation returns a status code as response, when this check box is selected. Message body is not required. For example, using a POST operation returns a 201 status code which means "Created" and responds with the resource URL.
  • Resource Schema: Displays the schema selected. This option is not available when the Use Custom Status Line and Response with Status Code Only check boxes are selected. These are the available options:
    • String
    • Integer
    • Boolean
    • XSD element: Selecting this option to either select the XSD schema element available under the Schemas folder of your project or a create new XML schema resource. Click Create New Schema to a create new XML schema resource using the Simplified Schema Editor wizard.
Response Status Specifies the response code for the operation and the code message. For example, code 201 means Created or code 503 means Service Unavailable.

You can also add your own custom code and reason phrase.

Path Parameters

This section shows the following details.

Parameter Name Type
Parameter name of the operation used The parameter type. It can be any one of the following:
  • String
  • Integer
  • Boolean
  • Long
  • Float
  • Double
  • Byte
  • Binary
  • Date
  • DateTime
  • Password

Policies

To associate a new or existing policy with the REST binding, click Policies node under the RestService tree, then click Add Policy to create a new policy. To edit an existing policy details, click the policy name and edit any of the following fields.

Field Description
Policy Name The name of the policy.
Policy Type The type of policy associated with the binding. The REST binding can support the Basic Authentication policy.
Description A description of the policy.