Request

Defines the endopoint of the API call.

The request definition contains the following:
  • Relative URL - The value specified for the relative URL is appended to the URL defined in the parent service. Alternatively, a full URL can be specified in the endpoint definition, in which case the URL of the service is ignored.
  • Method - The HTTP verb which can be one of the following
    • GET
    • POST
    • PUT
    • DELETE
    • PATCH
    • OPTIONS
    • HEAD
  • Content Type - The MIME type of the request body.
  • Request Body - The request body to be sent to the API.
  • Query Parameters - URL parameters to pass to the API. These can also be specified in the relative URL if preferred.
  • Headers - HTTP headers to sen in the request.
  • Parameters - Most of the request details can be parmeterized by specifying their value as "{$parameter-name}". Default values can be specified for the parameters in the request details.