Editing a component

Use this request to change the component parameters.

PATCH

https://api.tracker.yandex.net/v3/components/<component_ID>?version=<current_component_version>

Query format

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

To edit component parameters, use an HTTP PATCH request:

PATCH /v3/components/<component_ID>?version=<current_component_version>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
   "assignAuto": true
}
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 Cloud Organization organization is linked to Tracker. Learn more

  • 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 Cloud Organization.

    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
<current_component_version> Component version number. Number
Request body parameters

Additional parameters

Parameter Description Data type
name Component name. String
description Component description. String
lead Username of the component owner. String
assignAuto Default assignee attribute:
  • true: Assign the owner as the default assignee.
  • false: Don't assign a default assignee.
 Boolean

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/111175",
     "id": 111175,
     "version": 2,
     "name": "Component",
     "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/TEST",
        "id": "12345",
        "key": "TEST",
        "display": "Test queue"
     },
     "assignAuto": true
  }
Response parameters
Parameter Description Data type
self Address of the API resource with component parameters. String
id Component ID. Number
version Component version. Each change to the component parameters increases the version number. Number
name Component name. String
queue Object with information about the queue to which the component was added. Map item
assignAuto Indicates whether the owner is assigned as the default 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

If the request is processed incorrectly, the API returns a response with an error code:

400
One or more request parameters have an invalid value.
403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Creating a component
Next
Getting user permissions for a component