API Schema

The schema for a resource is obtained in the request parameter:

?format=json&schema=1

This way of requesting the schema is only available when requesting an Add form or when viewing a resource.

A specific url is also available for obtaining the schema of a resource:

GET /api/{model_type}/{model_name}/schema/?format=json&hierarchy=pkid

All the schemas are in JSON format.

To see a specific resource API schema, refer to the API Reference page for the resource in the API Reference material on the documentation portal.