Create a reusable Board Statement.

POST

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

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"),
    Content = new StringContent("{ \"Name\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"BoardTargetDefinitionId\": \"example\", \"Expression\": \"example\", \"IsEnabled\": true }")
    {
        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';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Name":"example","DisplayName":"example","Description":"example","BoardTargetDefinitionId":"example","Expression":"example","IsEnabled":true}'
};

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 \
  --header 'Content-Type: application/json' \
  --data '{ "Name": "example", "DisplayName": "example", "Description": "example", "BoardTargetDefinitionId": "example", "Expression": "example", "IsEnabled": true }'

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

Create a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true
}

Create a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true
}

Create a reusable Board Statement.

object

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

BoardTargetDefinitionId

string

nullable

Expression

string

nullable

IsEnabled

boolean

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Description": "example",
  "BoardTargetDefinitionId": "example",
  "Expression": "example",
  "IsEnabled": true
}

Responses

200

application/json

object

Data

One reusable Board Statement configured on a board.

object

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

application/json

object

Data

One reusable Board Statement configured on a board.

object

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

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

409

Conflict

application/json

object

Data

One reusable Board Statement configured on a board.

object

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

Create a reusable Board Statement.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated

Example^generated

Example^generated

Example^generated