Return one Board Constraint with activation health.

GET

/api/workspace/admin/boards/boards/{boardId}/constraints/{boardConstraintId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/boards/boards/example/constraints/example"),
};
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/constraints/example';
const options = {method: 'GET'};

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

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

Authorizations

None

Parameters

Path Parameters

boardId

required

string

boardConstraintId

required

string

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

One Board Constraint and its ordered applicability bindings.

object

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

FailureMessage

string

nullable

SortOrder

integer format: int32

IsEnabled

boolean

IsEnforcing

boolean

ActivationHealth

Activation health aggregated for one Board Constraint.

object

ConfigurationValid

boolean

RuntimeAvailable

boolean

CanEnable

boolean

Issues

Array<object>

nullable

One safe localized Board Constraint configuration issue.

object

Code

string

nullable

Message

string

nullable

SubjectId

string

nullable

Bindings

Array<object>

nullable

One Board Constraint trigger and Statement-set binding.

object

string

nullable

BoardConstraintId

string

nullable

TriggerType

integer format: int32

Allowed values: 0 1 2 3

FromBoardStatusId

string

nullable

ToBoardStatusId

string

nullable

BoardStatusId

string

nullable

EvaluatorType

integer format: int32

Allowed values: 0

LogicalOperator

integer format: int32

Allowed values: 0 1

SortOrder

integer format: int32

IsEnabled

boolean

IsEnforcing

boolean

ActivationHealth

Activation health for one Board Constraint Binding.

object

ConfigurationValid

boolean

RuntimeAvailable

boolean

CanEnable

boolean

ReachableTargetDefinitionIds

Array<string>

nullable

UncoveredTargetDefinitionIds

Array<string>

nullable

Issues

Array<object>

nullable

One safe localized Board Constraint configuration issue.

object

Code

string

nullable

Message

string

nullable

SubjectId

string

nullable

Statements

Array<object>

nullable

One ordered Board Statement selected by a constraint binding.

object

BoardStatementId

string

nullable

Name

string

nullable

DisplayName

string

nullable

BoardTargetDefinitionId

string

nullable

SortOrder

integer format: int32

IsEnabled

boolean

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

RowVersion

string format: uuid

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

{
  "Data": {
    "Bindings": [
      {
        "TriggerType": 0,
        "EvaluatorType": 0,
        "LogicalOperator": 0
      }
    ]
  },
  "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"
}

404

Not Found

application/json

object

Data

One Board Constraint and its ordered applicability bindings.

object

string

nullable

BoardId

string

nullable

Name

string

nullable

DisplayName

string

nullable

Description

string

nullable

FailureMessage

string

nullable

SortOrder

integer format: int32

IsEnabled

boolean

IsEnforcing

boolean

ActivationHealth

Activation health aggregated for one Board Constraint.

object

ConfigurationValid

boolean

RuntimeAvailable

boolean

CanEnable

boolean

Issues

Array<object>

nullable

One safe localized Board Constraint configuration issue.

object

Code

string

nullable

Message

string

nullable

SubjectId

string

nullable

Bindings

Array<object>

nullable

One Board Constraint trigger and Statement-set binding.

object

string

nullable

BoardConstraintId

string

nullable

TriggerType

integer format: int32

Allowed values: 0 1 2 3

FromBoardStatusId

string

nullable

ToBoardStatusId

string

nullable

BoardStatusId

string

nullable

EvaluatorType

integer format: int32

Allowed values: 0

LogicalOperator

integer format: int32

Allowed values: 0 1

SortOrder

integer format: int32

IsEnabled

boolean

IsEnforcing

boolean

ActivationHealth

Activation health for one Board Constraint Binding.

object

ConfigurationValid

boolean

RuntimeAvailable

boolean

CanEnable

boolean

ReachableTargetDefinitionIds

Array<string>

nullable

UncoveredTargetDefinitionIds

Array<string>

nullable

Issues

Array<object>

nullable

One safe localized Board Constraint configuration issue.

object

Code

string

nullable

Message

string

nullable

SubjectId

string

nullable

Statements

Array<object>

nullable

One ordered Board Statement selected by a constraint binding.

object

BoardStatementId

string

nullable

Name

string

nullable

DisplayName

string

nullable

BoardTargetDefinitionId

string

nullable

SortOrder

integer format: int32

IsEnabled

boolean

IsEventEligible

boolean

IsStatusInvariantEligible

boolean

RowVersion

string format: uuid

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

{
  "Data": {
    "Bindings": [
      {
        "TriggerType": 0,
        "EvaluatorType": 0,
        "LogicalOperator": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return one Board Constraint with activation health.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

Example^generated