Create an issue field

Use this request to create an issue global field.

Request format

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

To create a field, use an HTTP POST request. Request parameters are passed 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": "000000000000000000000001",
    "type": "ru.yandex.startrek.core.fields.StringFieldType"
}

Example: Create a 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: the first list item, the second list item, the third list item.

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": "myglobalfield",
  "category": "000000000000000000000003",
  "type": "ru.yandex.startrek.core.fields.StringFieldType",
  "optionsProvider": {
      "type": "FixedListOptionsProvider",
      "values": [
          "the first list item",
          "the second list item",
          "the third list item"
      ]
  }
}

Response format

 {
  "self": "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": [
          "The first list item",
          "The second list item",
          "The third list item"
      ]
  },
  "queryProvider": {
      "type": "StringOptionalQueryProvider"
  },
  "order": 5,
  "category": {
      "self": "https://api.tracker.yandex.net/v2/fields/categories/000000000000000000000001",
      "id": "000000000000000000000001",
      "display": "System"
  },
  "type": "standard"
}