1. REST API Guide
  2. Using the Describe Parameter to Return a REST Resource’s Metadata

Using the Describe Parameter to Return a REST Resource’s Metadata

You can retrieve metadata description in OpenAPI format (formerly known as Swagger) for any REST resource by simply appending the describe parameter to the URL and sending a GET request.

The following request uses the describe parameter to return REST resource metadata:

  • URI: <REST_RESOURCE_URL>/describe

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Request body: None