JSON Schema and an example for each change kind.

Static per server release: what change must look like for each kind POST /changes/plan accepts, as JSON Schema (draft 2020-12, input shape) with one valid example.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:clientportal-ai.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

The API version.

Available optionsv3

Example:v3

Path Parameters

projectIdstringrequired

The project's id.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

Example:prj_5f0c2a3e

Query Parameters

kindstring

One kind; absent returns every supported kind.

Possible values: Value must match regular expression ^[a-z][a-z_]{0,39}$

Example:modules

Response

200

application/json

The schemas.

kindsobject[]required

Every kind of change this project accepts, each with its schema.

Show child attributes