Skip to main content

API User Guide

The Platform REST APIs

The address of each API endpoint is:

https://<your_PDPP_environment_url>/api/v1/<ENDPOINT>

For example, the Term API endpoint is, https://<your_PDPP_environment_url>/api/v1/terms

There are platform APIs for:

The following sections are a brief description of the APIs, featuring a selected endpoint method in each case. To see all endpoints and methods, use Swagger. You can examine each API endpoint and see details, such as:

  • the available parameters, such as the desired object (term, tag, and so on) to be acted on and the exchange ID in which it resides

  • an example request body for create (POST) and update (PUT)

  • an example response code and message description

In this section: