Creating an issue field

Use this request to create an issue global field of issue.

Request formatRequest format

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

To create a field, use an HTTP POST request. Request parameters are provided in the request body in JSON format:

POST /v2/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

{
    "name":
    {
        "en": "Name in English",
        "ru": "Name in Russian"
    },
    "id": "global_field_key",
    "category": "0000000000000001********",
    "type": "ru.yandex.startrek.core.fields.StringFieldType"
}

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

• An HTTP POST method is used.
• Field type: FixedListOptionsProvider.
• Drop-down list values: list item 1, list item 2, list item 3.

POST /v2/fields
Host: https://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"
   },
   "id": "myglobalfield",
   "category": "0000000000000003********",
   "type": "ru.yandex.startrek.core.fields.StringFieldType",
   "optionsProvider": {
       "type": "FixedListOptionsProvider",
       "values": [
           "list item 1",
           "list item 1",
           "list item 3"
       ]
   }
}

Note

If you only have a Yandex Cloud Organization organization, use the X-Cloud-Org-ID header; if only Yandex 360 for Business or both organization types, use X-Org-ID.

Response formatResponse format

 {
  "self": "https://https://api.tracker.yandex.net/v2/fields/global_field_key",
  "id": "global_field_key",
  "name": "Field name in Russian",
  "description": "Field description",
  "key": "global_field_key",
  "version": 1,
  "schema": {
      "type": "array",
      "items": "string",
      "required": false
  },
  "readonly": false,
  "options": true,
  "suggest": false,
  "optionsProvider": {
      "type": "FixedListOptionsProvider",
      "needValidation": true,
      "values": [
          "List item 1",
          "List item 2",
          "List item 3"
      ]
  },
  "queryProvider": {
      "type": "StringOptionalQueryProvider"
  },
  "order": 5,
  "category": {
      "self": "https://https://api.tracker.yandex.net/v2/fields/categories/0000000000000001********",
      "id": "0000000000000001********",
      "display": "System"
  },
  "type": "standard"
}