Schema-exclusive API reference

After you create a schema, you can download a YAML file that your software developers can use as an API reference for that schema when developing applications that use the schema.

The documentation is created according to the OpenAPIv3 (formerly Swagger) standard.

Downloading the API reference

  1. Go to Data Management module icon Data Management > Schema Builder.
  2. In the list of schemas, locate the schema and click Three dot icon.
  3. In the menu that opens, click Documentation.
  4. Save the file to your machine.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.