Create a Plan

Creates a new schema definition for creating a plan.

🚧

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the Org Token type of Authorization token.

❗️

BPQL Object Syntax

When Creating a Plan, one of the body parameters to fill in is the bpql. As this is within BigPanda's API, the specific BPQL Object Syntax should be referenced.

Please do not confuse this with the UI centric string formatted BPQL.

📘

Plan ID

Noting down the ID string in the output will be helpful if you want to manually stop the maintenance period. This can also be retrieved with a GET call at any time

Returns

Possible response codes include:

  • 201 Created—new schema definition was created successfully.
  • 400 Bad Request—schema definition was not created because the request was missing parameters or not properly formatted. The response body includes additional error information for debugging.
Language