Evaluate a Board Statement against an explicit proposed context.

POST

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/boards/boards/example/statements/preview"),
    Content = new StringContent("{ \"BoardTargetDefinitionId\": \"example\", \"Expression\": \"example\", \"Values\": { \"additionalProperty\": {} }, \"Collections\": { \"additionalProperty\": [ { \"additionalProperty\": {} } ] } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/boards/boards/example/statements/preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"BoardTargetDefinitionId":"example","Expression":"example","Values":{"additionalProperty":{}},"Collections":{"additionalProperty":[{"additionalProperty":{}}]}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

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

Evaluate a Board Statement against an explicit proposed context. Values are keyed by canonical profile path. Collection rows are keyed by collection path.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Values

object

key

additional properties

object

Collections

object

key

additional properties

Array<object>

object

key

additional properties

object

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "Values": {
    "additionalProperty": {}
  },
  "Collections": {
    "additionalProperty": [
      {
        "additionalProperty": {}
      }
    ]
  }
}

Evaluate a Board Statement against an explicit proposed context. Values are keyed by canonical profile path. Collection rows are keyed by collection path.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Values

object

key

additional properties

object

Collections

object

key

additional properties

Array<object>

object

key

additional properties

object

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "Values": {
    "additionalProperty": {}
  },
  "Collections": {
    "additionalProperty": [
      {
        "additionalProperty": {}
      }
    ]
  }
}

Evaluate a Board Statement against an explicit proposed context. Values are keyed by canonical profile path. Collection rows are keyed by collection path.

object

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

Values

object

key

additional properties

object

Collections

object

key

additional properties

Array<object>

object

key

additional properties

object

Example^generated

{
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "Values": {
    "additionalProperty": {}
  },
  "Collections": {
    "additionalProperty": [
      {
        "additionalProperty": {}
      }
    ]
  }
}

Responses

200

application/json

object

Data

Result of evaluating a proposed Board Statement context.

object

Validation

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

Value

boolean

nullable

EvaluationErrorCode

string

nullable

EvaluationErrorMessage

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

application/json

object

Data

Result of evaluating a proposed Board Statement context.

object

Validation

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

Value

boolean

nullable

EvaluationErrorCode

string

nullable

EvaluationErrorMessage

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

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

Evaluate a Board Statement against an explicit proposed context.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated