Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 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
      • Home page
      • My issues
      • Working with issues
      • Favorite issues, boards, and dashboards
      • Personal settings
    • Migrating to Yandex Tracker
    • Disabling paid services
  • Yandex Tracker mobile app
  • Practical guidelines
    • 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
      • Collect requests statistics
      • Configuring integration with third-party platforms
  • Concepts
    • Yandex Tracker overview
    • Concepts
  • Configuring queues
    • Overview
    • Creating a queue
    • Queue templates
    • Viewing issues in a queue
    • Changing basic queue settings
    • Configuring issue types and statuses
      • Overview
      • Configuring issue types
      • Create a workflow
      • Setting up statuses
      • Configuring transitions
      • Creating a resolution
    • Local issue fields
    • Adding a queue team
    • Setting access rights for queues
    • Advanced queue features
    • Viewing the history of queue changes
    • Deleting a queue
  • Working with issues
    • Creating an issue
      • Overview
      • Creating an issue via email
      • Creating an issue from a form
      • Cloning an issue
    • Editing an issue
      • Overview
      • Adding comments to issues
      • Creating a checklist
      • Editing issue links
      • Attaching images and files to an issue
      • Formatting text in issues
      • Executing macros
      • Voting for an issue
      • Moving 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
    • Components
    • Versions
  • Agile development tools
    • Overview
    • Creating a board
    • Working with an agile board
    • Editing and deleting a board
    • Sprints
    • Epics
    • Collaborative workload estimation
    • Burn down charts
  • Searching issues
    • Finding issues by key or name
    • Searching for my issues
    • Searching for 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
    • Notification settings
      • Overview
      • Notifications about your issues
      • Notifications about your subscriptions
  • Statistics and dashboards
    • Dashboards
      • Overview
      • Creating a dashboard
      • Widgets
      • Editing a dashboard
      • Shared access to dashboards
      • Making a dashboard your home page
    • Queue statistics
    • Gantt charts
  • 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
      • 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 schedules
  • Integration with other services
    • Mail
    • 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
    • Plugin for IDE
    • API
    • Python client
    • Connecting repositories
  • Pricing policy
    • Pricing
    • Setting up a billing account
    • Topping up your personal account
    • Viewing service detalization
  • API reference
    • Overview
    • API access
    • Issues
      • Get issue parameters
      • Editing an issue
      • Creating an issue
      • Moving an issue to another queue
      • Find out the number of issues
      • Find issues
      • Release scroll view resources
      • Get priorities
      • Get issue links
      • Link issues
      • Get transitions
      • Make a status transition
      • Get the history of issue changes
    • Checklists
      • Create a checklist or add items to it
      • Get checklist parameters
      • Edit a checklist
      • Delete a checklist
    • Projects
      • Creating a project
      • Get project parameters
      • Get a list of all projects
      • Get a list of project queues
      • Edit a project
      • Deleting a project
    • Comments
      • Add comment
      • Get issue comments
      • Edit a comment
      • Delete a comment
    • Macros
      • Get queue macros
      • Get a macro
      • Creating 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
      • Attaching a file
      • Upload a temporary file
      • Delete a file
    • Queues
      • Creating a queue
      • Get queue parameters
      • Get a list of queues
      • Get queue versions
      • Get required fields for the queue
      • Deleting a queue
      • Restore a queue
      • Remove a tag from a queue
      • Automation
        • Receiving triggers
        • Creating triggers
    • Issue boards
      • Get parameters of all boards
      • Get board parameters
      • Creating 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
    • 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
  • FAQ
  • Support
  1. API reference
  2. Issue fields
  3. Get issue field parameters

Get issue field parameters

Written by
Yandex Cloud
  • Request format
  • Response format

Request format

To get possible values of an issue field, use an HTTP GET request:

GET /v2/fields/<field-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>
Headers
  • Host

    Address of the node that provides the API:

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

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07
    
  • X-Org-ID

    Organization ID.

Resource
Parameter Description Data type
<field-id> Issue field ID. String

Response format

Successful execution of the request
The request failed

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://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://api.tracker.yandex.net/v2/fields/categories/58bc3b921d9c7d68164e",
        "id": "58bc3b921d9c7d68164e",
        "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.
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
suggestProvider Object with information about the search suggestion class.
You can't 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 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 suggestProvider

Parameter Description Data type
type Search suggestion class. String

Object fields optionsProvider

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

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 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.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.

Was the article helpful?

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