Return server-computed move options for one readable board item.

GET

/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move-options

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

Authorizations

None

Parameters

Path Parameters

boardIdOrKey

required

string

boardItemId

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

Available move options for one board item.

object

BoardItemId

string

nullable

FromBoardStatusId

string

nullable

Options

Array<object>

nullable

Dry-run move option for one target board status.

object

BoardStatusId

string

nullable

DisplayName

string

nullable

Color

string

nullable

Allowed

boolean

BoardTransitionId

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

CloseBlockers

Open child items blocking a terminal move.

object

TotalCount

integer format: int32

HiddenCount

integer format: int32

ReadableChildren

Array<object>

nullable

Compact board item summary used by item-link surfaces.

object

string

nullable

BoardId

string

nullable

BoardKey

string

nullable

BoardDisplayName

string

nullable

RunNumber

integer format: int32

DisplayName

string

nullable

Subtitle

string

nullable

BoardStatusId

string

nullable

BoardStatusDisplayName

string

nullable

BoardStatusColor

string

nullable

BoardTargetDefinitionId

string

nullable

BoardTargetDefinitionDisplayName

string

nullable

IsOpen

boolean

IsRestricted

boolean

HiddenChildren

Array<object>

nullable

Safe summary for a hidden child blocker.

object

BoardDisplayName

string

nullable

RunNumber

integer format: int32

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": {
    "Options": [
      {
        "Errors": [
          {
            "Type": 0,
            "Severity": 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

Available move options for one board item.

object

BoardItemId

string

nullable

FromBoardStatusId

string

nullable

Options

Array<object>

nullable

Dry-run move option for one target board status.

object

BoardStatusId

string

nullable

DisplayName

string

nullable

Color

string

nullable

Allowed

boolean

BoardTransitionId

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

CloseBlockers

Open child items blocking a terminal move.

object

TotalCount

integer format: int32

HiddenCount

integer format: int32

ReadableChildren

Array<object>

nullable

Compact board item summary used by item-link surfaces.

object

string

nullable

BoardId

string

nullable

BoardKey

string

nullable

BoardDisplayName

string

nullable

RunNumber

integer format: int32

DisplayName

string

nullable

Subtitle

string

nullable

BoardStatusId

string

nullable

BoardStatusDisplayName

string

nullable

BoardStatusColor

string

nullable

BoardTargetDefinitionId

string

nullable

BoardTargetDefinitionDisplayName

string

nullable

IsOpen

boolean

IsRestricted

boolean

HiddenChildren

Array<object>

nullable

Safe summary for a hidden child blocker.

object

BoardDisplayName

string

nullable

RunNumber

integer format: int32

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": {
    "Options": [
      {
        "Errors": [
          {
            "Type": 0,
            "Severity": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Available move options for one board item.

object

BoardItemId

string

nullable

FromBoardStatusId

string

nullable

Options

Array<object>

nullable

Dry-run move option for one target board status.

object

BoardStatusId

string

nullable

DisplayName

string

nullable

Color

string

nullable

Allowed

boolean

BoardTransitionId

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

CloseBlockers

Open child items blocking a terminal move.

object

TotalCount

integer format: int32

HiddenCount

integer format: int32

ReadableChildren

Array<object>

nullable

Compact board item summary used by item-link surfaces.

object

string

nullable

BoardId

string

nullable

BoardKey

string

nullable

BoardDisplayName

string

nullable

RunNumber

integer format: int32

DisplayName

string

nullable

Subtitle

string

nullable

BoardStatusId

string

nullable

BoardStatusDisplayName

string

nullable

BoardStatusColor

string

nullable

BoardTargetDefinitionId

string

nullable

BoardTargetDefinitionDisplayName

string

nullable

IsOpen

boolean

IsRestricted

boolean

HiddenChildren

Array<object>

nullable

Safe summary for a hidden child blocker.

object

BoardDisplayName

string

nullable

RunNumber

integer format: int32

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": {
    "Options": [
      {
        "Errors": [
          {
            "Type": 0,
            "Severity": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return server-computed move options for one readable board item.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

409

Example

Example^generated