Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Tracker
  • Getting started
    • Activating Yandex Tracker
    • Logging in to Yandex Tracker
    • Adding users
    • Configuring access to Yandex Tracker
    • Setting up Yandex Tracker
    • Working with Yandex Tracker
      • Start page
      • My issues
      • Working with issues
      • Favorite issues, boards, and dashboards
      • Personal settings
    • Migrating to Yandex Tracker
    • Disabling paid services
  • Yandex Tracker mobile app
  • Tutorials
    • Setting up Yandex Tracker for a development team
      • Overview
      • Creating a queue for a development team
      • Structuring issues
      • Using Agile methodologies
      • Configuring issue templates
      • Connecting repositories
      • Automating recurring actions
      • Integrating Yandex Tracker with other platforms
    • Setting up Yandex Tracker for a support team
      • Overview
      • Creating a queue for the support team
      • Accepting requests by mail and via forms
      • Configuring multi-tiered support
      • Sending emails from the issue page
      • Grouping requests by topic
      • Tracking the time it takes to process a request
      • Collecting request statistics
      • Configuring integration with third-party platforms
  • Concepts
    • Service overview
    • Concepts
    • Roles and access rights
  • Configuring queues
    • Overview
    • Create a queue
    • Queue templates
    • Viewing issues in a queue
    • Changing basic queue settings
    • Changing basic queue settings
      • Overview
      • Configuring issue types
      • Creating a workflow
      • Setting up statuses
      • Configuring transitions
      • Setting up resolutions
    • Local issue fields
    • Adding a queue team
    • Setting access rights for queues
    • Advanced queue features
    • Viewing the history of queue changes
    • Delete a queue
  • Working with issues
    • Create an issue
      • Overview
      • Creating an issue via email
      • Creating an issue from a form
      • Cloning an issue
    • Edit an issue
      • Overview
      • Adding comments to issues
      • Creating a checklist
      • Editing issue links
      • Attaching images and files to an issue
      • Formatting text in issues
      • Voting for an issue
      • Move an issue to another queue
      • Changing multiple issues
    • Setting up an issue reminder
    • Registering time spent
    • Adding issue fields
    • Viewing the history of issue changes
    • Getting access to an issue
    • Deleting an issue
  • Structuring issues
    • Overview
    • Links between issues
    • Projects
      • Overview
      • Create a project
      • List of project issues
      • Gantt chart
    • Components
    • Versions
  • Agile development tools
    • Overview
    • Create a board
    • Working with an agile board
    • Editing or deleting a board
    • Backlog
    • Sprints
    • Epics
    • Collaborative workload estimation
    • Burn down charts
  • Issue boards (beta)
    • Overview
    • Create a board
    • Working with an agile board
    • Setting up a board
  • Find issues
    • Finding issues by key or name
    • Finding my issues
    • Finding issues in queues
    • Creating an issue filter
    • Query language
  • Notifications and subscriptions
    • Overview
    • Subscribing to notifications
    • Receiving update reports
    • Subscribing other users to queue updates
    • Email notification settings
      • Overview
      • Notifications about your issues
      • Notifications about your subscriptions
    • Sending notifications to mailboxes in your domain
  • Statistics and dashboards
    • Dashboards
      • Overview
      • Creating a dashboard
      • Widgets
      • Editing a dashboard
      • Shared access to dashboards
      • Making a dashboard your start page
    • Queue statistics
    • Gantt chart
  • Automation and templates
    • Overview
    • Triggers
      • Overview
      • Creating triggers
      • Setting trigger conditions
      • Configuring trigger actions
      • Editing and deleting triggers
      • Examples
    • Auto actions
      • Overview
      • Automatic issue updates
      • Scheduled issue creation
      • Editing or deleting auto actions
    • Macros
    • Templates
      • Overview
      • Creating a template in Yandex Forms (beta)
      • Creating a template
      • Editing a template
      • Deleting a template
      • Using shared templates
    • Variables
    • Using a form as a template for creating issues
  • Configuring an SLA for issues
    • Overview
    • Configuring rules
    • Work schedule
  • Integration with other services
    • Email
    • Yandex Forms
    • Yandex Wiki
    • Messengers
      • Overview
      • Slack
      • Telegram
    • Setting up links to external applications
      • Overview
      • Setting up an external application
      • Sending your application data to the Tracker team
  • Developer tools
    • API
    • Python client
    • Connecting repositories
  • Pricing policy
    • Billing
    • Setting up a billing account
    • Paying for services
    • Viewing service usage details
  • API reference
    • Overview
    • API access
    • General query format
    • Issues
      • Get issue parameters
      • Edit an issue
      • Create an issue
      • Moving an issue to another queue
      • Find out the number of issues
      • Search for issues
      • Release scroll view resources
      • Get priorities
      • Get transitions
      • Make a status transition
      • Get the history of issue changes
      • Issue links
        • Link issues
        • Get issue links
        • Remove issue links
    • Checklists
      • Create a checklist or add items to it
      • Get checklist parameters
      • Edit a checklist
      • Delete a checklist
    • Projects
      • Create a project
      • Get project parameters
      • Get a list of all projects
      • Get a list of project queues
      • Edit a project
      • Delete a project
    • Comments
      • Add comment
      • Get issue comments
      • Edit a comment
      • Delete a comment
    • Macros
      • Get queue macros
      • Get a macro
      • Create a macro
      • Edit a macro
      • Delete a macro
    • External links
      • Get a list of external applications
      • Get a list of issue external links
      • Add an external link
      • Delete an external link
    • Attached files
      • Get a list of attached files
      • Download a file
      • Download a thumbnail
      • Attach a file
      • Upload a temporary file
      • Delete a file
    • Queues
      • Create a queue
      • Get queue parameters
      • Get a list of queues
      • Get queue versions
      • Get required fields for the queue
      • Delete a queue
      • Restore a queue
      • Remove a tag from a queue
      • Automation
        • Auto actions
          • Create an auto action
          • Get auto action parameters
        • Triggers
          • Creating a trigger
          • Get trigger parameters
    • Issue boards
      • Get parameters of all boards
      • Get board parameters
      • Create a board
      • Edit a board
      • Delete a board
      • Columns
        • Get parameters of all columns
        • Get column parameters
        • Create a column
        • Edit a column
        • Delete a column
      • Sprints
        • Get all sprints of a board
        • Get a sprint
        • Create a sprint
    • Components
      • Get a list of components
    • Import
      • Import an issue
      • Import files
      • Import comments
      • Import links
    • Bulk operations
      • Perform a bulk move of issues to a different queue
      • Bulk changes to issues
      • Make bulk changes to issue statuses
    • Time tracking
      • Add a record of time spent
      • Edit a record of time spent
      • Delete a record of time spent
      • Get records of time spent
        • Get all records for an issue
        • Select records by parameters
    • Issue fields
      • Get global issue fields
      • Create an issue field
      • Get issue field parameters
      • Edit issue field names
      • Edit possible values of issue fields
      • Create an issue field category
      • Local fields
        • Create a local queue field
        • Get local queue fields
        • Get information about a local queue field
        • Edit a local queue field
    • Get information about the current user
    • Possible response codes
  • Questions and answers
    • General questions
    • Billing
  • Revision history
    • November 2022
    • October 2022
    • September 2022
    • August 2022
  • Support
  1. API reference
  2. Issue fields
  3. Create an issue field

Create an issue field

Written by
Yandex Cloud
  • Request format
  • Response format

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"
}
Headers
  • Host

    API host address:

    https://api.tracker.yandex.net
    
  • Authorization

    OAuth token in OAuth <token value> format. For example:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07
    
  • X-Org-ID

    Organization ID.

Request body parameters

Required parameters

Parameter Description Data type
name Field name:
  • en: In English.
  • ru: In Russian.
String
id Field ID. String
category Object with information about the field category.
To get a list of all categories, use the HTTP request:
GET /v2/fields/categories
String
type Field type:
  • ru.yandex.startrek.core.fields.DateFieldType: Date.
  • ru.yandex.startrek.core.fields.DateTimeFieldType: Date/Time.
  • ru.yandex.startrek.core.fields.StringFieldType: One-line text field.
  • ru.yandex.startrek.core.fields.TextFieldType: Multi-line text field.
  • ru.yandex.startrek.core.fields.FloatFieldType: Fractional number.
  • ru.yandex.startrek.core.fields.IntegerFieldType: Integer
  • ru.yandex.startrek.core.fields.UserFieldType: User's name.
  • ru.yandex.startrek.core.fields.UriFieldType: Link.
String

Additional parameters

Parameter Description Data type
optionsProvider Object with information about the list items. Object
order Sequence number in the list of organization fields: https://tracker.yandex.com/admin/fields. Number
description Field description. String
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 isn't empty.
  • false: Don't hide the field.
Boolean
container Indicates if you can specify multiple values in the field (like in the Tags field):
  • true: You can specify multiple values in the field.
  • false: You can only specify one value in the field.
This parameter can be used for the following types of fields:
  • ru.yandex.startrek.core.fields.StringFieldType: One-line text field.
  • ru.yandex.startrek.core.fields.UserFieldType: User's name.
  • drop-down list (see the optionsProvider description).
Boolean

Object fields optionsProvider

Parameter Description Data type
type Type of drop-down list:
  • 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: 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

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 created issue field in JSON 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"
}
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. Object
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 the drop-down list items. Object
queryProvider Object with information about the query language class.
You can't 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

Object fields schema

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

Object fields optionsProvider

Parameter Description Data type
type Type of drop-down list. String
needValidation Indicates if a list value requires validation:
  • true: Yes.
  • false: No.
Boolean
values List items. Array of strings

Object fields queryProvider

Parameter Description Data type
type Query language type. String

Object fields category

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 response with an error code:

400
One or more request parameters have an invalid value.
401
The user isn't authorized. Make sure to perform the actions described in API access.
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.
422
JSON validation error, the request is rejected.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Request format
  • Response format