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.
  • Pagination Type - Specifies a type of pagination. Select one of the pagination types as follows:
    • None

      Pagination is not enabled.

    • Offset
      For the properties, refer to the following table:
      Property Description
      Records per Call The number of records to fetch per call.
      Limit The total number of records to return across all calls.
      First Offset The offset value to provide in the first call.
      End of Data Indicator This property specifies how the REST service reports that the page is the final page. This property has the following possible values:
      • Number of Records

        A field in the response, or in a header value, provides the total number of records being returned.

      • Is Last

        A Boolean field in the response, or in a header value, specifies that the current page is the last page.

      • Has More

        A Boolean field in the response, or in a header value, specifies that the current page is not the last page.
      End of Data Location The location in response as where to find the total number of records. Select end of data location from:
      • Header
      • Body
      Number of Records Path Header name or the path for which the total number of records are found. This property is applicable only when the Pagination Type is set to Offest and End of Data Indicator is set to Number of Pages.

      See JSON Paths to specify path.
      Is Last Path Header name or the path where the is last indicator is found. This is a Boolean field or header that has the value of true to indicate that the last page has been reached.

      See JSON Paths to specify path.
      Has More Path Header name or the path where the has more indicator is found. This is a Boolean field or header that has the value of true to indicate that there are more pages to be fetched.

      See JSON Paths to specify path.
    • Page
      For the properties, refer to the following table:
      Property Description
      Records per Call The number of records to fetch per call.
      First Page The page value to provide in the first call.
      Number of Pages Location The location where to find total number of pages. Select number of pages location from:
      • Header
      • Body
      End of Data Indicator This property specifies how the REST service reports that the page is the final page. This property has the following possible values:
      • Number of Pages

        A field in the response, or in a header value, provides the total number of pages being returned.

      • Is Last

        A Boolean field in the response, or in a header value, specifies that the current page is the last page.

      • Has More

        A Boolean field in the response, or in a header value, specifies that the current page is not the last page.
      Number of Pages Path Header name or the path for which the URL for the next page is found. This property is applicable only when the Pagination Type is set to Page and End of Data Indicator is set to Number of Pages.

      See JSON Paths to specify path.
      Is Last Path Header name or the path where the is last indicator is found. This is a Boolean field or header that has the value of true to indicate that the last page has been reached.

      See JSON Paths to specify path.
      Has More Path Header name or the path where the has more indicator is found. This is a Boolean field or header that has the value of true to indicate that there are more pages to be fetched.

      See JSON Paths to specify path.
    • Next Page Link
      For the properties, refer to the following table:
      Property Description
      Next Page Link Location The name of the header or the path in the body for the field containing the URL for the next page. Select the next page link location from:
      • Header
      • Body
      Next Page Link Path Header name or the path for which the URL for the next page is found.

      See JSON Paths to specify path.
    • Next Page Token
      For the properties, refer to the following table:
      Property Description
      Next Token Location The name of the header or the path in the body for the field containing the token for the next page. Select the next token location from:
      • Header
      • Body
      Next Token Path Header name or the path for which the token for the next page is found.

      See JSON Paths to specify path.
      Pagination Token Location Location where the pagination token for subsequent calls would be configured. Select the pagination token location from:
      • Parameter
      • Header
      Pagination Token name Name of the pagination token to be passed in the next subsequent calls.
JSON Paths

The syntax for specifying paths for fields in JSON responses follows the JSON Path specification.

Properties that use the JSON paths are:
  • Number of Records Path
  • Number of Pages Path
  • Is Last Path
  • Has More Path
  • Next Page Link Path
  • Next Page Token Path

You can specify the path for the properties as follows:

/key1/key2

For example, given this JSON response:
{
   "token1": "111",
   "object1": {
      "token2": "222"
   },
   "array1": [
      {
          "token3": "222"
      }
   ]
}
The paths for the tokens are:
  • Token1: /token1
  • Token2:/object1/token2
  • Token3:/array1/0/token3
Note: For arrays, the integral value for the index is specified, where the first element in the array has an index of 0. To access the last element of an array specify the index with the special value -1.
Pagination Special Values

In paginated API calls, the pagination parameters are provided either as query parameters, or (less commonly) as request header values. Since these values change with each call to the API, a mechanism is provided to specify these varying parameters.

This is provided by special properties that have the syntax {{…}}. These special values are as follows:
Value Description
{{record_count}} The value of the Records per Call property.
{{offset}} The next offset value. On each call this will be incremented by the value of the Records per Call property.
{{page}} The next page number. On each call this will be incremented.
{{pagination_token}} The pagination token from the prior call. On the first call, the query parameter or header will not be set. On subsequent calls, it will be set to the value of the pagination token from the previous call.

For example, an API that uses offset pagination where the number of records and offset are passed as query parameters would use these special values as mentioned in the following URL specification:

GET https://domain.com/api/resources?num_records={{record_count}}&offset={{offset}}