Editing an issue field category

Use this request to edit the category of an issue field.

PATCH

https://api.tracker.yandex.net/v3/fields/categories/<category_id>?version=<category_version>

Query format

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

Use an HTTP PATCH request to edit the category of an issue field. In the request body, specify the parameters in JSON format:

PATCH /v3/fields/categories/<category_id>?version=<category_version>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": {
        "en": "en_name",
        "ru": "ru_name"
        },
        "description": "description",
    "order": 400
}

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
<category_id>	ID of the category for the issue field.	String

Request parameters

Additional parameters

Parameter	Description	Data type
version	Category version. Changes apply only to the current category version.	Number

Request body parameters

Required parameters

Parameter	Description	Data type
name	Category name: `en`: In English. `ru`: In Russian	String
order	Weight of the field when displayed in the interface. Fields with a lower weight are displayed above fields with a higher weight.	Number

Additional parameters

Parameter	Description	Data type
description	Category description.	String

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 201 Created.

The response body contains information about the updated project in JSON format.

{
    "id" : "604f9920d23cd5********",
    "name" : "category_name",
    "self": "https://api.tracker.yandex.net/v3/fields/categories/604f9920d23cd5********",
    "version" : 2
}

Response parameters

Parameter	Description	Data type
id	Unique ID of the category.	String
name	Category name in Russian.	String
self	Address of the API resource with information about the category.	String
version	Category version. Each change to the field increments the version number.	Number

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.

401: The user is not authorized. Make sure that actions described in the API access section are performed.

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.

422: JSON validation error, the request is rejected.

500: Internal service error. Try again later.

503: The API service is temporarily unavailable.

Was the article helpful?

Creating an issue field category

Creating a local queue field