Response parameters
This page lists the standard issue parameters that are available by default in Tracker, as well as describes the standard objects that an issue can contain.
In addition to standard parameters, an issue can contain:
- Global custom fields created in your organization.
- Local fields specific to a particular queue.
When retrieving information about an issue, the API returns the following fields:
|
Parameter |
Description |
Data type |
|
Array of objects with information about users listed in the Access field |
Array of objects |
|
|
affectedVersions |
Versions listed in the Affected versions field |
JSON array |
|
aliases |
Array with information about alternative issue keys |
Array of strings |
|
Object with information about the issue assignee |
Object |
|
|
List of attached files. Displayed in the response if the |
Array of objects |
|
|
Array of objects with information about the issue boards where the issue is located |
Array of objects |
|
|
checklistDone |
Number of completed checklist items |
Number |
|
Array of objects with information about checklist items |
Array of objects |
|
|
checklistTotal |
Number of checklist items |
Number |
|
Issue comments. Displayed in the response if the |
Array of objects |
|
|
commentWithExternalMessageCount |
Number of comments with external messages |
Integer |
|
commentWithoutExternalMessageCount |
Number of comments without external messages |
Integer |
|
Array of objects with information about queue components that the issue belongs to |
Array of objects |
|
|
createdAt |
Issue creation date and time in the format |
String |
|
Object with information about the issue author |
Object |
|
|
deadline |
Issue deadline in the format |
Date |
|
description |
Issue description |
String |
|
emailCc |
CC recipients of the email from which the issue was created |
Array of strings |
|
emailCreatedBy |
Sender address on behalf of which the email was created |
String |
|
emailFrom |
Sender address of the email from which the issue was created |
String |
|
emailTo |
Recipient addresses of the email from which the issue was created |
Array of strings |
|
end |
Issue completion date in the format |
Date |
|
epic |
Epic that the issue belongs to |
Object |
|
estimation |
Estimate in work days, hours, or minutes. Format: |
String |
|
favorite |
Favorite issue indicator:
|
Boolean |
|
Versions listed in the Fix versions field |
JSON array |
|
|
Array of objects with information about issue followers |
Array of objects |
|
|
followingMaillists |
Array of objects with information about mailing lists — teams and departments subscribed to the issue |
Array of objects |
|
id |
Issue identifier |
String |
|
key |
Issue key |
String |
|
lastCommentUpdatedAt |
Date and time of the last added comment in the format |
String |
|
Queue from which the issue was moved |
Object |
|
|
Primary linked goal |
Object |
|
|
List of linked issues. Displayed in the response if the |
Array of objects |
|
|
originalEstimation |
Original estimate in work days, hours, or minutes. Format: |
String |
|
Object with information about the parent issue |
Object |
|
|
Array of objects with information about employees whose reply is pending |
Array of objects |
|
|
Queue from which the issue was moved |
Object |
|
|
Object with information about the previous issue status |
Object |
|
|
Object with information about the priority |
Object |
|
|
Object with information about the issue projects |
Object |
|
|
Object with information about the QA engineer |
Object |
|
|
Object with information about the issue queue |
Object |
|
|
Object with information about the user for whom a reply was received |
Object |
|
|
Object with information about the issue resolution |
Object |
|
|
resolvedAt |
Date and time when the issue was moved to the Resolved status in the format |
String |
|
Object with information about the employee who moved the issue to the Resolved status |
Object |
|
|
self |
Address of the API resource containing information about the issue |
String |
|
Information about SLA rules |
Array of objects |
|
|
spent |
Value of the Time spent parameter |
String |
|
Array of objects with information about the sprint |
Array of objects |
|
|
start |
Issue start date in the format |
Date |
|
Object with information about the issue status |
Object |
|
|
statusStartTime |
Date and time of the last issue status change in the format |
String |
|
Issue status type |
Object |
|
|
storyPoints |
Issue estimate in story points |
Number |
|
summary |
Issue summary |
String |
|
tags |
Issue tags |
Array of strings |
|
List of available transitions to other statuses. Displayed in the response if the |
Array of objects |
|
|
Object with information about the issue type |
Object |
|
|
unique |
Optional field whose value must be unique within Tracker organization. You can use such a value to prevent creating duplicate issues, for example using a trigger. If you try to create an issue with the same parameter value again, no duplicate will be created and the response will contain an error with code 409 |
String |
|
updatedAt |
Date and time of the last issue change in the format |
String |
|
Object with information about the last employee who changed the issue |
Object |
|
|
version |
Issue version. Each change of issue parameters increments the version number. |
Number |
|
Array with identifiers or logins of users who voted for the issue |
Array of objects |
|
|
Users who voted for the issue |
Array of objects |
|
|
votes |
Number of votes for the issue |
Number |
Objects in issue parameters
Objects with user data
The assignee, createdBy, updatedBy, followers, resolvedBy, pendingReplyFrom, and voters parameters contain information about users.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the user | String |
| id | User ID. | String |
| display | Displayed user name | String |
| passportUid | Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. | Number |
| cloudUid | Unique user ID in Yandex Cloud Organization | String |
type object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the issue type. | String |
| id | Issue type ID | String |
| key | Issue type key. | String |
| display | Issue type name displayed. | String |
priority object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the priority. | String |
| id | Priority ID | String |
| key | Priority key. | String |
| display | Priority name displayed. | String |
Fields of the status object
The status and previousStatus parameters contain information about the issue status.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the status. | String |
| id | Status ID. | String |
| key | Status key. | String |
| display | Status name displayed. | String |
Fields of the queue object
The queue parameter contains information about the issue queue.
| 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 |
Fields of the parent object
The parent parameter contains information about the parent issue.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the issue. | String |
| id | Issue ID. | String |
| key | Issue key. | String |
| display | Issue name displayed. | String |
Fields of objects in the links array
The links parameter contains information about issue links.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the link | String |
| id | Link identifier | Number |
| type | Block with information about the link type | Object |
| direction | Type of link of the issue specified in the request relative to the issue in the object field. Possible values:
|
String |
| object | Block with information about the linked issue | Object |
| createdBy | Block with information about the link creator | Object |
| updatedBy | Block with information about the last user who changed the linked issue | Object |
| createdAt | Link creation date and time | String |
| updatedAt | Link modification date and time | String |
| assignee | Assignee of the linked issue | Object |
| status | Status of the linked issue | Object |
Fields of the project object
The project parameter contains information about projects that the issue belongs to.
| Parameter | Description | Data type |
|---|---|---|
| primary | Main issue project | Object |
| secondary | List of additional issue projects | Array of objects |
If the request address specifies API v2, the project object contains information only about the main project.
Fields of the object containing project data
The primary and secondary parameters contain objects with the following fields:
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the project | String |
| id | Project ID | String |
| display | Project name displayed | String |
Fields of the linkedGoals object
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the goal | String |
| id | Goal identifier | String |
| display | Goal name | String |
Sprint array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the sprint. | String |
| id | Sprint ID. | String |
| display | Sprint name displayed. | String |
Fields of the attachments object
The attachments parameter contains information about attached files.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the file | String |
| id | File identifier | String |
| name | File name | String |
| content | Address for downloading the file | String |
| thumbnail | Address for downloading the thumbnail (for images) | String |
| createdBy | Object with information about the user who uploaded the file | Object |
| createdAt | File upload date and time | String |
| mimetype | File type | String |
| size | File size in bytes | Number |
Fields of the comments object
The comments parameter contains information about issue comments.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the comment | String |
| id | Comment identifier | String |
| objectId | Comment identifier in hexadecimal format | String |
| display | Comment text | String |
Fields of the sla object
The sla parameter contains information about SLA rules.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource | String |
| id | SLA rule identifier | Number |
| key | SLA rule key | String |
| name | SLA rule name | String |
| status | SLA rule execution status | String |
Fields of the checklistItems object
| Parameter | Description | Data type |
|---|---|---|
| id | Сhecklist item ID. | String |
| text | Text of the checklist item. | String |
| textHtml | Text of the checklist item in HTML format. | String |
| checked | Checklist item completion flag:
|
Boolean |
| assignee | Assignee of the checklist item. | Map object |
| deadline | Deadline for the checklist item. | Map object |
| checklistItemType | Type of the checklist item. | String |
Fields of the access object
The access parameter contains information about issue access rights.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource | String |
| id | User or group identifier | String |
| display | Display name | String |
Fields of the boards object
| Parameter | Description | Data type |
|---|---|---|
| id | Board identifier | String |
| name | Board name | String |
Fields of the fixVersions object
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the version | String |
| id | Version identifier. | String |
| display | Version name | String |
Fields of the components object
The components parameter contains information about queue components.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the component | String |
| id | Component identifier | Number |
| display | Component display name | String |
Fields of the resolution object
The resolution parameter contains information about the issue resolution.
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource containing information about the resolution | String |
| id | Resolution identifier | Number |
| key | Resolution key | String |
| display | Resolution display name | String |
type object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the issue type. | String |
| id | Issue type ID | String |
| key | Issue type key. | String |
| display | Issue type name displayed. | String |
Fields of the statusType object
| Parameter | Description | Data type |
|---|---|---|
| id | Status type identifier | Number |
| display | Status display name | String |
| key | Technical status key (for example, "inProgress", "open", "resolved", "paused") | String |