path | String Relative path of the individual endpoints of the REST API. | ||
httpMethod | String Specifies the HTTP method you want to use. Valid values are: get post put delete patch options head | ||
body | Document Optional. Body of the REST API request. | ||
scheme | String Transfer protocol that you want to use to send the REST API request. Valid values are: http https | ||
produces | String Optional. MIME media type the REST operation can produce and send back to the REST client. Valid values are: application/xml application/json | ||
consumes | String Optional. MIME media type the REST operation can consume or accept from the REST client. Valid values are: application/xml application/json | ||
basePath | String Optional. Base path on which the REST API is served, which is relative to the host. If base path is not included, the REST API is served directly under the host. The path must begin with a “/” (slash). | ||
auth | Document Optional. Authorization information that this service submits to the server. | ||
Key | Description | ||
type | String Type of authentication scheme that you want this service to use. Set to: BASIC: to submit a user name and password. This is the default. | ||
username | String User name that this service will submit when requesting a protected resource. Required only when type is set to Basic. | ||
password | String Password associated with username. Required only when type is set to Basic. | ||
params | Document Optional. All path parameters must be added under this document as key value pairs. | ||
Key | Description | ||
path | Document Optional. Path parameters of the REST API request. | ||
query | Document Optional. Query parameters of the REST API request. | ||
form | Document Optional. Form parameters of the REST API request. | ||
header | Document Optional. Headers from the REST API request and responses. | ||
host | String Host serving the REST API. | ||
code | String HTTP code of the REST API response. |
phrase | String HTTP message of the REST API response. |
response | Object Optional. Body of the REST API response as a document or document list. |