Update a reusable Board Statement.

PUT

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

curl --request PUT \
  --url https://example.com/api/workspace/admin/boards/boards/example/statements/example \
  --header 'Content-Type: application/json' \
  --data '{ "Name": "example", "DisplayName": "example", "Description": "example", "BoardTargetDefinitionId": "example", "Expression": "example", "IsEnabled": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• None

Parameters

Path Parameters

boardId

required

string

boardStatementId

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

Update a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

Data

One reusable Board Statement configured on a board.

object

Id

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

SortOrder

integer format: int32

IsEnabled

boolean

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

RowVersion

string format: uuid

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

One reusable Board Statement configured on a board.

object

Id

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

SortOrder

integer format: int32

IsEnabled

boolean

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

RowVersion

string format: uuid

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

One reusable Board Statement configured on a board.

object

Id

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

SortOrder

integer format: int32

IsEnabled

boolean

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

RowVersion

string format: uuid

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

409

Conflict

Media typeapplication/json

object

Data

One reusable Board Statement configured on a board.

object

Id

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

NormalizedExpression

string

nullable

EngineVersion

string

nullable

ProfileVersion

integer format: int32

SchemaFingerprint

string

nullable

ProfileFingerprint

string

nullable

ExpressionFingerprint

string

nullable

ArtifactFingerprint

string

nullable

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

SortOrder

integer format: int32

IsEnabled

boolean

Dependencies

Array<object>

nullable

One bound Board Statement dependency.

object

Kind

string

nullable

DependencyId

string

nullable

Path

string

nullable

CollectionScope

string

nullable

IsStatusInvariantSafe

boolean

RowVersion

string format: uuid

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