Validate and bind a Board Statement expression without persisting it.

POST

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

curl --request POST \
  --url https://example.com/api/workspace/admin/boards/boards/example/statements/validate \
  --header 'Content-Type: application/json' \
  --data '{ "BoardTargetDefinitionId": "example", "Expression": "example" }'

Authorizations

• None

Parameters

Path Parameters

boardId

required

string

Query Parameters

access_token

string

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

Request Body

Validate and bind a Board Statement expression without persisting it.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example"
}

Validate and bind a Board Statement expression without persisting it.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example"
}

Validate and bind a Board Statement expression without persisting it.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example"
}

Responses

200

OK

Media typeapplication/json

object

Data

Result of validating and binding a Board Statement expression.

object

Success

boolean

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

nullable

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

nullable

IsStatusInvariantEligible

boolean

nullable

Complexity

Compiled Board Statement complexity metrics.

object

NodeCount

integer format: int32

MaximumDepth

integer format: int32

MaximumPathSegments

integer format: int32

MaximumCollectionItems

integer format: int32

MaximumFunctionArguments

integer format: int32

ExpressionUtf8Bytes

integer format: int32

TokenCount

integer format: int32

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

Diagnostics

Array<object>

nullable

One position-aware Board Statement DSL diagnostic.

object

Code

string

nullable

Message

string

nullable

Start

integer format: int32

Length

integer format: int32

Token

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
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Result of validating and binding a Board Statement expression.

object

Success

boolean

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

nullable

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

nullable

IsStatusInvariantEligible

boolean

nullable

Complexity

Compiled Board Statement complexity metrics.

object

NodeCount

integer format: int32

MaximumDepth

integer format: int32

MaximumPathSegments

integer format: int32

MaximumCollectionItems

integer format: int32

MaximumFunctionArguments

integer format: int32

ExpressionUtf8Bytes

integer format: int32

TokenCount

integer format: int32

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

Diagnostics

Array<object>

nullable

One position-aware Board Statement DSL diagnostic.

object

Code

string

nullable

Message

string

nullable

Start

integer format: int32

Length

integer format: int32

Token

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"
}