Get a component

Use this request to get component parameters.

GET

https://api.tracker.yandex.net/v3/components/{component_ID}

Query format

Before making a request, get permission to access the API.

To get a component, use an HTTP GET request.

GET /v3/components/{component_ID}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID
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
component_ID Component ID. Number
Request parameters
Parameter Description Data type
fields Comma-separated list of fields to return: version, name, queue, description, lead, assignAuto. The self and id fields are always returned. String

If you pass the ETag value from a previous response in the If-None-Match header and the component has not changed, the API returns 304 without a response body.

Response format

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

The response body contains a JSON object with component parameters.

{
    "self": "https://api.tracker.yandex.net/v3/components/123",
    "id": 123,
    "version": 1,
    "name": "Component",
    "description": "Component description",
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/TEST",
        "id": "1",
        "key": "TEST",
        "display": "Test queue"
    },
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "User Name"
    },
    "assignAuto": false
}
Response parameters
Parameter Description Data type
self Link to the component object. String
id Component ID. Number
version Component version. Number
name Component name. String
description Component description. String
queue Queue that contains the component. Map item
lead Component owner. Map item
assignAuto Whether to automatically assign the component owner as the assignee. Boolean

queue object fields

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

lead object fields

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

If the component is not found, the API returns the following error code:

404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Get queue components
Next
Create a component