Search Results

REST Reference 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
Implementation Resource

or

Resource Service Path

The Swagger specification in the project which defines the REST endpoint. This field is visible only when the reference is defined by a Swagger specification, otherwise this field is replaced by the Resource Service Path which is the path to the resource.
Resource Service Path Resource path of the REST Resource to invoke.
HTTP Client The name of the HTTP Client.
Tip: Click on the HTTP Client Name field to display details about the HTTP Connector resource.
Request Client Format

The type of request message format

The two available reply message format options are: JSON or XML.

Applies to all operations unless overridden at the operation level.

Reply Client Format The type of reply message format.

The two available reply message format options are: JSON or XML.

Applies to all operations unless overridden at the operation level.

Path Parameters If Path parameters are defined in the REST service that the REST Reference is calling, they appear in the Path Parameters table. However, you cannot modify the Path parameters since the REST Reference must adhere to the parameters defined by the service.

Summary tab

This tab shows the following details.

Field Description
Summary A brief description of the operation.
HTTP Method A unique identifier for the operation that identifies the operation in the entire API. By default, it is set to <HTTP-Method>-<resource_name>.
Notes A field that can be used to describe the operation. Any text that is entered in the Notes field appears in the Swagger file.

Request tab

This section shows the following details.

Field Description
Format Client request format, JSON, XML, or Text.
JSON Definition Style Specifies whether the request item is a single element or an anonymous array.
Request Data type of the payload, can be primitive data type or complex data type.
Query and Header Parameters

Click the parameter name to edit it.

These are the available options:
  • String
  • Integer
  • Boolean
  • Long
  • Float
  • Double
  • Byte
  • Binary
  • Date
  • Date Time
  • Password

Repeating and Required values can be toggled.

Response tab

This tab shows the following details.

Field Description
Use HTTP Headers Select this checkbox only if you require a service to send back a custom header or value or if you need to see the response headers. This checkbox is checked by default if custom headers are used.
Format Response format requested by the client , can be JSON, XML, or Text. The service must support the format(s) that the client requests for this operation.
JSON Definition Style Specifies whether the response item is a single element or an anonymous array.
Resource Schema Data type of the response being sent back, can be either primitive or complex data type.
Header Parameters Click the parameter name to edit it.

These are the available types:

  • String
  • Integer
  • Boolean
  • Long
  • Float
  • Double
  • Byte
  • Binary
  • Date
  • Date Time
  • Password

Repeating and Required values can be toggled.

Response Status tab

This tab shows the following details.

Field Description
Code The response code returned.
Type These are the available options:
  • String
  • Integer
  • Boolean
  • XSD element: Select this option to either select the XSD schema element available under the Schemas folder of your project or create a new XML schema resource.
Reason Phrase A brief description of what the code indicates.

Policies

To associate a new or existing policy with the REST Binding, click Policies node under the Rest Reference 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 Reference Binding supports the Basic Credential Mapping policy.
Description A description of the policy.