Validate a Board Constraint Binding without persisting it.

POST

/api/workspace/admin/boards/boards/{boardId}/constraints/bindings/validate

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/constraints/bindings/validate"),
    Content = new StringContent("{ \"TriggerType\": 0, \"FromBoardStatusId\": \"example\", \"ToBoardStatusId\": \"example\", \"BoardStatusId\": \"example\", \"LogicalOperator\": 0, \"BoardStatementIds\": [ \"example\" ] }")
    {
        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/constraints/bindings/validate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"TriggerType":0,"FromBoardStatusId":"example","ToBoardStatusId":"example","BoardStatusId":"example","LogicalOperator":0,"BoardStatementIds":["example"]}'
};

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/constraints/bindings/validate \
  --header 'Content-Type: application/json' \
  --data '{ "TriggerType": 0, "FromBoardStatusId": "example", "ToBoardStatusId": "example", "BoardStatusId": "example", "LogicalOperator": 0, "BoardStatementIds": [ "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 a Board Constraint Binding without persisting it.

object

TriggerType

integer format: int32

Allowed values: 0 1 2 3

FromBoardStatusId

string

nullable

ToBoardStatusId

string

nullable

BoardStatusId

string

nullable

LogicalOperator

integer format: int32

Allowed values: 0 1

BoardStatementIds

Array<string>

nullable

Responses

200

application/json

object

Data

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

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

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

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

Validate a Board Constraint Binding without persisting it.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

Example^generated