Create an active link for one readable board item.

POST

/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/boards/example/items/example/links"),
    Content = new StringContent("{ \"LinkType\": 0, \"Direction\": 0, \"OtherBoardItemId\": \"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/boards/example/items/example/links';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"LinkType":0,"Direction":0,"OtherBoardItemId":"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/boards/example/items/example/links \
  --header 'Content-Type: application/json' \
  --data '{ "LinkType": 0, "Direction": 0, "OtherBoardItemId": "example" }'

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.

Request Body

Request to create an active board item link.

object

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

OtherBoardItemId

string

nullable

Responses

200

application/json

object

Data

Grouped active board item links for one item.

object

BoardItemId

string

nullable

CanManage

boolean

Parent

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Children

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Related

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

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": {
    "Parent": {
      "LinkType": 0,
      "Direction": 0
    },
    "Children": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ],
    "Related": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Grouped active board item links for one item.

object

BoardItemId

string

nullable

CanManage

boolean

Parent

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Children

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Related

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

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": {
    "Parent": {
      "LinkType": 0,
      "Direction": 0
    },
    "Children": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ],
    "Related": [
      {
        "LinkType": 0,
        "Direction": 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

Grouped active board item links for one item.

object

BoardItemId

string

nullable

CanManage

boolean

Parent

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Children

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Related

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

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": {
    "Parent": {
      "LinkType": 0,
      "Direction": 0
    },
    "Children": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ],
    "Related": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Grouped active board item links for one item.

object

BoardItemId

string

nullable

CanManage

boolean

Parent

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Children

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

Related

Array<object>

nullable

Runtime board item link row displayed relative to one item.

object

string

nullable

BoardItemLinkTypeId

string

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

SourceBoardItemId

string

nullable

TargetBoardItemId

string

nullable

CreatedAtUtc

string format: date-time

CreatedByUserId

string

nullable

OtherItem

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

CanRemove

boolean

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": {
    "Parent": {
      "LinkType": 0,
      "Direction": 0
    },
    "Children": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ],
    "Related": [
      {
        "LinkType": 0,
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create an active link for one readable board item.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated