Generate and import an OpenAPI document

Application management : Tools : REST API : Basic features : Using definitions : Generate and import an OpenAPI document

For each REST API definition, an OpenAPI document is available. This document contains information how to use the endpoints for this specific definition and can be downloaded from:

{domain}/sdk/system/rest/v2/openapi/{configuration ID}.json

OpenAPI documents can only be created from REST API definitions that have status Published. If they are not Published, they cannot yet receive API requests.

Steps to generate an OpenAPI document:

• Suppose the Planon software can be accessed with this url: https://xxxxx.plnd.cloud/home/BP/WebClient?21

• And suppose we have published the REST API definition ‘Department’

• Then, the OpenAPI document of the Department definition can be accessed through https://xxxxx.plnd.cloud/sdk/system/rest/v2/openapi/Department.json

• Save this JSON document on your network

• Import this JSON document in the tool that you will use for sending API requests

Further explanation of the OpenAPI document can be found in section OpenAPI document.