Get issue links with pagination

Use this request to get a page from the issue link list with an HTTP POST request.

POST

https://api.tracker.yandex.net/v3/issues/{issue_id}/links/_list?page=PAGE&perPage=ITEMS_PER_PAGE

Request format

Before making the request, get access to the API.

To get a link list, use an HTTP POST request. Pass a JSON object in the request body:

POST /v3/issues/{issue_id}/links/_list?page=PAGE&perPage=ITEMS_PER_PAGE
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID

{
    "fields": [],
    "linkTypes": [
        "relates"
    ]
}
Headers

  • Host: address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth OAUTH_TOKEN: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer IAM_TOKEN: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. Learn more

  • ID types

    X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Identity Hub.

    Finding the ID

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
issue_key_or_ID ID or key of the current issue. String
Query parameters
Parameter Description Data type
page Response page number. Number
perPage Number of links per response page. Number
Request body parameters
Parameter Description Data type
fields Fields to include in the response. String array
linkTypes Link type IDs to include in the response. String array

Example: Get an issue link list

POST https://api.tracker.yandex.net/v3/issues/JUNE-2/links/_list?page=1&perPage=20
Content-Type: application/json

{
    "fields": [],
    "linkTypes": ["relates"]
}

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains an object with the links array.

{
    "links": [
        {
            "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/links/47001",
            "id": 47001,
            "type": {
                "self": "https://api.tracker.yandex.net/v3/linktypes/relates",
                "id": "relates",
                "inward": "relates",
                "outward": "relates"
            },
            "direction": "outward",
            "object": {
                "self": "https://api.tracker.yandex.net/v3/issues/TREK-9844",
                "id": "593cd211ef7e8a33********",
                "key": "TREK-9844",
                "display": "Related issue"
            },
            "createdAt": "2017-06-11T05:16:01.421+0000",
            "updatedAt": "2017-06-11T05:16:01.421+0000"
        }
    ]
}

Response parameters

Parameter Description Data type
links Array of issue link objects. Array of objects

Parameter

Description

Data type

self

Address of the API resource that contains information about the link

String

id

Link ID

Number

type

Block with link type information

Object

direction

Type of relationship of the issue specified in the request relative to the issue in the object field. Possible values:

  • outward — the issue specified in the request is primary for the issue in the object field;
  • inward — the issue in the object field is primary for the issue specified in the request

String

object

Block with linked issue information

Object

createdBy

Block with link creator information

Object

updatedBy

Block with information about the last user who modified the linked issue

Object

createdAt

Date and time the link was created

String

updatedAt

Date and time the link was modified

String

assignee

Assignee of the linked issue

Object

status

Status of the linked issue

Object
Parameter Description Data type
self Link to the link type. String
id Link type ID. String
inward Name of the link type for the issue in the object field relative to the issue specified in the request. String
outward Name of the link type for the issue specified in the request relative to the issue in the object field. String

Fields of the object object

Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
display Issue name displayed. String

Fields of the createdBy, updatedBy, and assignee objects

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Identity Hub String

Fields of the status object

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String
Previous
Get issue links
Next
Delete a link with an issue