View API Schema and Generate Payload Format

You can view the Offline Mediation Controller REST API schema by downloading the API in JSON format.

View API Schema

To view the REST API schema:
  1. On the navigation bar on the left panel of the REST API document, click the Download icon:

    Download Icon

    The download panel appears.
  2. Click Swagger.

    A JSON file is generated in a new browser tab.

  3. Copy the contents of the JSON file and paste it into a Swagger editor, such as https://editor.swagger.io/.
  4. To access the payload format:
    1. Scroll to and expand the desired endpoint.
    2. Select your desired format, either application/xml or application/json, from the drop-down list on the upper right of the Request Body section.
    3. Copy the sample request body from the web page and paste it into your own file.
    4. Remove any parameters you do not need and fill in the appropriate values. See the page for the endpoint in this guide for information about the parameters.