Editing a local queue field

Use this request to edit a local issue field linked to a given queue.

PATCH

https://api.tracker.yandex.net/v3/queues/<queue_ID>/localFields/<field_key>

Query format

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

To edit a local field, use an HTTP PATCH request. In the request body, specify the parameters in JSON format:

PATCH /v3/queues/<queue_ID>/localFields/<field_key>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name":
    {
        "en": "Field name in English",
        "ru": "Field name in Russian"
    },
    "category": "0000000000000002********",
    "order": 102,
    "description": "Field description",
    "readonly": true,
    "visible": false,
    "hidden": false
}

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
<queue_ID>	Queue ID or key. The queue key is case-sensitive.	String
<field_key>	Local field key. To get the key, use this HTTP request: `GET /v3/queues/<queue_ID>/localFields`	String

Request body parameters

Additional parameters

Parameter	Description	Data type
name	Local field name: `en`: In English. `ru`: In Russian	String
category	Object with information about the field category. To get a list of all categories, use the HTTP request: `GET /v3/fields/categories`	String
order	Sequence number in the list of organization fields: https://tracker.yandex.com/admin/fields	Number
description	Local field description	String
optionsProvider	Object with information about the list items	Map item
readonly	Shows if the field value is editable: `true`: Non-editable `false`: Editable	Boolean
visible	Indicates if the field is visible in the interface: `true`: Always visible `false`: Not visible	Boolean
hidden	Indicates if the field should be hidden in the interface: `true`: Hide the field even if it is not empty `false`: Do not hide the field	Boolean

optionsProvider object fields

Parameter	Description	Data type
type	Drop-down list type: `FixedListOptionsProvider`: List of strings or numbers (for the `ru.yandex.startrek.core.fields.StringFieldType` or `ru.yandex.startrek.core.fields.IntegerFieldType` field types) `FixedUserListOptionsProvider`: List of users (for the `ru.yandex.startrek.core.fields.UserFieldType` field type)	String
values	Drop-down list values	Array of strings

Example: Editing a fixed set of string values for the local field of the Drop-down list type.

An HTTP PATCH method is used.

Field type: FixedListOptionsProvider.

Drop-down list values: "First list item", "Second list item", "Third list item".
PATCH /v3/queues/<queue_ID>/localFields/<field_key>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "optionsProvider": {
    "type": "FixedListOptionsProvider",
    "values": [
         "List item 1",
         "List item 2",
         "List item 3"
       ]
   }
}

Response format

Request executed successfully

Request failed

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

The response body contains information about the local queue field in JSON format.

 {
    "type": "local",
    "self": "https://api.tracker.yandex.net/v3/queues/ORG/localFields/loc_field_key",
    "id": "6054ae3a2b6b2c7f********--loc_field_key",
    "name": "Field name in Russian",
    "description": "Field description",
    "key": "loc_field_key",
    "version": 2,
    "schema": {
        "type": "string",
        "required": false
    },
    "readonly": true,
    "options": true,
    "suggest": false,
    "optionsProvider": {
       "type": "FixedListOptionsProvider",
       "needValidation": true,
       "values": [
          "List item 1",
          "List item 2",
          "List item 3"
         ]
      },
    "queryProvider": {
         "type": "StringOptionalQueryProvider"
    },
    "order": 102,
    "category": {
        "self": "https://api.tracker.yandex.net/v3/fields/categories/0000000000000002********",
        "id": "0000000000000002********",
        "display": "category_name"
    },    
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Organization"
    }
 }

Response parameters

Parameter	Description	Data type
type	Field type	String
self	Address of the API resource with information about the field	String
id	Unique field ID	String
name	Field name	String
description	Field description	String
key	Field key	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	Map item
readonly	Shows if the field value is editable: `true`: Non-editable `false`: Editable	Boolean
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.	Boolean
suggest	Enables/disables search suggestions when entering field values: `true`: Enabled `false`: Disabled	Boolean
optionsProvider	Object with information about allowed field values.	Map item
queryProvider	Object with information about the query language class. You cannot change the class using the API.	Map item
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 /v3/fields/categories`	Map item
queue	Object with information about the issue queue.	Map item

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	Boolean

optionsProvider object fields

Parameter	Description	Data type
type	Drop-down list type	String
needValidation	Indicates if a list value requires validation: `true`: Yes `false`: Do not validate the field value	Boolean
values	Drop-down list values	Array of strings

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

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.

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?

Getting information about a local queue field

Overview