Search readable and manageable item-link candidates. An explicit target-definition filter scopes target-provider search, owning Board Data search, and the final candidate query.

POST

/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/link-candidates

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/link-candidates"),
    Content = new StringContent("{ \"SearchText\": \"example\", \"BoardTargetDefinitionIds\": [ \"example\" ], \"LinkType\": 0, \"Direction\": 0, \"Limit\": 1 }")
    {
        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/link-candidates';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"SearchText":"example","BoardTargetDefinitionIds":["example"],"LinkType":0,"Direction":0,"Limit":1}'
};

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/link-candidates \
  --header 'Content-Type: application/json' \
  --data '{ "SearchText": "example", "BoardTargetDefinitionIds": [ "example" ], "LinkType": 0, "Direction": 0, "Limit": 1 }'

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

Search request for board item link picker candidates.

object

SearchText

Optional free text or #RunNumber lookup.

string

nullable

BoardTargetDefinitionIds

Optional active target-definition ids. When supplied, the scope limits the complete search pipeline: target providers, owning Board Data, and the final candidate query. When omitted, search covers all active Boards and target definitions with bounded per-source presearch.

Array<string>

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

Limit

Requested result limit from 1 through 50.

integer format: int32

nullable

Search request for board item link picker candidates.

object

SearchText

Optional free text or #RunNumber lookup.

string

nullable

BoardTargetDefinitionIds

Array<string>

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

Limit

Requested result limit from 1 through 50.

integer format: int32

nullable

Search request for board item link picker candidates.

object

SearchText

Optional free text or #RunNumber lookup.

string

nullable

BoardTargetDefinitionIds

Array<string>

nullable

LinkType

integer format: int32

Allowed values: 0 1

Direction

integer format: int32

Allowed values: 0 1

Limit

Requested result limit from 1 through 50.

integer format: int32

nullable

Responses

200

application/json

object

Data

Server-backed item-link picker candidates.

object

BoardId

string

nullable

TotalCount

integer format: int32

Limit

integer format: int32

Items

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

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

Server-backed item-link picker candidates.

object

BoardId

string

nullable

TotalCount

integer format: int32

Limit

integer format: int32

Items

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

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

404

Not Found

application/json

object

Data

Server-backed item-link picker candidates.

object

BoardId

string

nullable

TotalCount

integer format: int32

Limit

integer format: int32

Items

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

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

409

Conflict

application/json

object

Data

Server-backed item-link picker candidates.

object

BoardId

string

nullable

TotalCount

integer format: int32

Limit

integer format: int32

Items

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

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

Search readable and manageable item-link candidates. An explicit target-definition filter scopes target-provider search, owning Board Data search, and the final candidate query.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated