Creating an issue field category

Use this request to create a category for an issue field.

POST

https://api.tracker.yandex.net/v3/fields/categories

Query format

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

To create an issue field category, use an HTTP POST request. In the request body, specify the parameters in JSON format:

POST /v3/fields/categories
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": {
        "en": "Name in English",
        "ru": "Name in Russian"
        },
        "description": "Text 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.

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

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" : 1
}
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 increases 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.
Previous
Editing possible issue field values
Next
Creating a local queue field