Request

About this task

Fill in the following fields in Request.

Procedure

  1. The URL defined in the service to which the Relative URL is appended in the Service URL.(The URL is auto populated from the parent Service to which this endpoint belongs.)
  2. In the Relative URL, type the URL relative to the base URL defined in the service. An absolute path can also be specified, in which case the service’s URL will be ignored.
  3. Select one of the following options in Method.
    • GET
    • POST
    • PUT
    • DELETE
    • PATCH
    • HEAD
    • OPTIONS
  4. To add query parameters, click Add a row under the Query Parameters section and enter the required details in the table.

    The parameter value can be specified in one of the following ways:

    • As a literal value
    • As a request parameter value, specified as {$param-name}.

    Each parameter also supports the following optional properties:

    • Required: Specifies whether the parameter is mandatory.
    • URL Encoded: Indicates whether the parameter value is already URL encoded. This property is set to false by default. If the value is already URL encoded, it must be set to true.

    Click on Add a row to add more values.

  5. Select one of the following options in Pagination Type to specify the type of pagination.
    • None
    • Offset
    • Page
    • Next Page Link
    • Next Page Token
  6. Click on Add a row under Parameters to fill in the details of values in the table of request parameters. The parameters can be used in the URL, headers, or query parameter, specifying the parameter name as {$param-name}. Click on Add a row to add more values.
  7. Click on Add a row to add the name of the trigger column under Triggers.. Click on Add a row to add more values.
  8. Click on Call API, to trigger the response of the selected API.
  9. Click on Next to enter Response