Contact UsGet started

Editing an issue field name

Written by
Updated at February 19, 2024

Request format

To change an issue field name, use an HTTP PATCH request:

PATCH /v2/fields/<field_ID>?version=<field_version>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
  "name":
      {
       "en":"en_name",
       "ru":"ru_name"
      }
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<field_ID> Issue field ID. String
<field_version> Issue field version. String
Request body parameters

Required parameters

Parameter Description Data type
name Object with information about the issue field name. Object

name object fields

Parameter Description Data type
en Field name in English. String
ru Field name in Russian. String

Response format

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

The response body contains a JSON object with all issue field parameters.

{
    "self": "https://https://api.tracker.yandex.net/v2/fields/ruName",
    "id": "ruName",
    "name": "ru_name",
    "description": "description text",
    "version": 3,
    "schema": {
        "type": "array",
        "items": "string",
        "required": false
    },
    "readonly": false,
    "options": true,
    "suggest": true,
    "suggestProvider": {
        "type": "UserSuggestProvider"
    },
    "optionsProvider": {
        "type": "FixedListOptionsProvider",
        "values": [
            "value 1",
            "value 2"
        ]
    },
    "queryProvider": {
        "type": "StringOptionalQueryProvider"
    },
    "order": 14,
    "category": {
        "self": "https://https://api.tracker.yandex.net/v2/fields/categories/58bc3b921d9c********",
        "id": "58bc3b921d9c********",
        "display": "System"
    }
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue field. String
id Field ID String
name Field name String
description Field description String
version Field version; each change to the field increases the version number Number
schema Object with information about the field value's data type Object
readonly Shows if the field value is editable:
  • true: Non-editable
  • false: Editable
 Logical
options Shows if the list of values is restricted:
  • true: The list of values is not restricted, you can set any value
  • false: The list of values is restricted by the organization's settings
 Logical
suggest Enables/disables search suggestions when entering field values:
  • true: Enabled
  • false: Disabled
 Logical
suggestProvider Object with information about the search suggestion class.
You cannot change the class using the API.		 Object
optionsProvider Object with information about allowed field values. Object
queryProvider Object with information about the query language class.
You cannot change the class using the API.		 Object
order Sequence number in the list of organization fields: https://tracker.yandex.com/admin/fields Number
category Object with information about the field category.
To get a list of all categories, use the HTTP request:
GET /v2/fields/categories		 Object

schema object fields

Parameter Description Data type
type Field value type Possible data types:
  • string: String; available for fields with a single value
  • array: Array; available for fields with multiple values
 String
items Value type; available for fields with multiple values String
required Shows if the field is required:
  • true: Required
  • false: Optional
 Logical

suggestProvider object fields

Parameter Description Data type
type Search suggestion class. String

optionsProvider object fields

Parameter Description Data type
type Type of field values. String
values Array of field values. Array

queryProvider object fields

Parameter Description Data type
type Query language type String

category object fields

Parameter Description Data type
self Address of the API resource with information about the field category String
id Field category ID String
display Category name displayed String

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
403
Insufficient rights 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.
412
There was a conflict when editing the object. The error may be due to an invalid update version.
422
JSON validation error, the request is rejected.
428
Access to the resource is denied. Make sure all required conditions for the request are specified.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Getting issue field parameters
Next
Editing possible issue field values