About REST Requests
When you select
Request for an operation,
Designer displays the input parameters of the REST operation and the request body details.
Note:
Integration Server does not support XML structure without a root element while sending a REST request or receiving a REST response.
REST request parameters and request body details
Parameters
When you select
Parameters under
Request,
Designer displays the following information for each parameter:
Name: Matches the name of the input parameter in the corresponding service.
Type: Specifies the data type of the parameter.
Source: Indicates the source of the parameters in the incoming request. The source corresponds to the
in field of the parameter object as defined by the OpenAPI Specification 3.0.x. A parameter can have one of the following source values:
PATH
QUERY
HEADER
COOKIE
Required: Indicates whether or not the parameter is required in the input.
Designer obtains this value from the
Required property for the parameter in the corresponding REST operation.
You can also click
to view the additional parameter details, for example,
Media type,
Style,
Extensions, and
Constraints.
Request Body
The body of the REST requests lists the media types consumed by the operation, for example, application/json and specifies the schema for each media type. Designer displays the following details for the REST request:
Name: Specifies the media type.
Type: Specifies the data type.
Constraints: Indicates the keywords used to validate the schema for the request body.
Designer can use one or more of the following supported constraints to validate schemas as per OpenAPI Specification 3.0.x.
oneOf: Validates a value against exactly one of the subschemas.
allOf: Validates a value against all the subschemas.
anyOf: Validates a value against any (one or more) of the subschemas.
not: Ensures that the value is not valid against a specified schema.
Request bodies are required: This check box indicates whether or not the request body is required in the input.
Designer obtains this value from the
Required property for the request body. This check box is selected when the
Required property is set as
true.
