Return the server-owned Board Statement DSL authoring schema.

GET

/api/workspace/admin/boards/boards/{boardId}/statements/authoring

curl --request GET \
  --url https://example.com/api/workspace/admin/boards/boards/example/statements/authoring

Authorizations

• None

Parameters

Path Parameters

boardId

required

string

Query Parameters

boardTargetDefinitionId

string

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Server-owned Board Statement authoring schema.

object

ProfileKey

string

nullable

ProfileVersion

integer format: int32

EngineVersion

string

nullable

Roots

Array<object>

nullable

One root available in the Board Statement DSL profile.

object

Name

string

nullable

Paths

Array<object>

nullable

One scalar Board Statement DSL path.

object

Path

string

nullable

ValueFamily

string

nullable

Nullable

boolean

Description

string

nullable

Collections

Array<object>

nullable

One collection available to EXISTS and COUNT.

object

Path

string

nullable

ItemPaths

Array<object>

nullable

One scalar Board Statement DSL path.

object

Path

string

nullable

ValueFamily

string

nullable

Nullable

boolean

Description

string

nullable

Description

string

nullable

Operators

Array<string>

nullable

Variables

Array<string>

nullable

Functions

Array<object>

nullable

One function available in the Board Statement DSL profile.

object

Name

string

nullable

ArgumentFamilies

Array<Array<string>>

nullable

ResultFamilies

Array<string>

nullable

Description

string

nullable

Example

string

nullable

LiteralExamples

Array<string>

nullable

DiagnosticCodes

Array<string>

nullable

Examples

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

Server-owned Board Statement authoring schema.

object

ProfileKey

string

nullable

ProfileVersion

integer format: int32

EngineVersion

string

nullable

Roots

Array<object>

nullable

One root available in the Board Statement DSL profile.

object

Name

string

nullable

Paths

Array<object>

nullable

One scalar Board Statement DSL path.

object

Path

string

nullable

ValueFamily

string

nullable

Nullable

boolean

Description

string

nullable

Collections

Array<object>

nullable

One collection available to EXISTS and COUNT.

object

Path

string

nullable

ItemPaths

Array<object>

nullable

One scalar Board Statement DSL path.

object

Path

string

nullable

ValueFamily

string

nullable

Nullable

boolean

Description

string

nullable

Description

string

nullable

Operators

Array<string>

nullable

Variables

Array<string>

nullable

Functions

Array<object>

nullable

One function available in the Board Statement DSL profile.

object

Name

string

nullable

ArgumentFamilies

Array<Array<string>>

nullable

ResultFamilies

Array<string>

nullable

Description

string

nullable

Example

string

nullable

LiteralExamples

Array<string>

nullable

DiagnosticCodes

Array<string>

nullable

Examples

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}