Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Importing an issue

Written by
Updated at February 19, 2024

Warning

This request can only be made on behalf of the administrator.

Use it to import to Tracker tasks from other project management systems.

Request format

To import an issue, use an HTTP POST request. Issue parameters are passed in the request body in JSON format:

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

{
  "queue": "TEST",
  "summary": "Test",
  "createdAt": "2017-08-29T12:34:41.740+0000",
  "createdBy": 11********
}

If necessary, you can extend the list of fields available for import. Create additional fields in Tracker and specify them in the request body in the format:

"<field_name>": "<field_value>"
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Request body parameters

Required parameters

Parameter Description Data type
queue Queue key. String
summary Issue name, no more than 255 characters. String
createdAt Issue creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format. Must be no later than the current time. String
createdBy Username or ID of the user who created the issue.
  • String for the username
  • Number for the ID

Additional parameters

Parameter Description Data type
key Issue key. The key must belong to the queue that the issue is imported to.

If this parameter is omitted, the issue is assigned a key automatically.		 String
updatedAt Date and time of the issue's last update in YYYY-MM-DDThh:mm:ss.sss±hhmm format. You can specify any value in the interval from the issue creation to the current time.

The parameter is only used together with the updatedBy parameter.		 String
updatedBy Username or ID of the user who edited the issue last.

The parameter is only used together with the updatedAt parameter.
  • String for the username
  • Number for the ID
resolvedAt Date and time when the resolution is added, in YYYY-MM-DDThh:mm:ss.sss±hhmm format. You can specify any value in the interval from issue creation to the time it was last updated.
The parameter is only used together with the resolution and resolvedBy parameters.		 String
resolvedBy Username or ID of the user who set the resolution.

The parameter is only used together with the resolution and resolvedAt parameters.
  • String for the username
  • Number for the ID
status Issue status ID. The status must be present in the queue workflow for the selected issue type.

If not specified, the initial status of the workflow is used.		 Number
deadline Deadline in YYYY-MM-DD format. String
resolution Issue resolution ID.

The parameter is only used together with the resolvedBy and resolvedAt parameters.		 Number
type Issue type ID The issue type must be present in the queue.

If not specified, the issue type that is selected as the default for the queue is used.		 Number
description Issue description, no more than 512,000 characters. String
start Start date in YYYY-MM-DD format. String
end End date in YYYY-MM-DD format. String
assignee Username or ID of the assignee.
  • String for the username
  • Number for the ID
priority Priority ID.

If no priority is specified, the priority that is selected as the default for the queue is used.		 Number
affectedVersions Version IDs listed in the Affected Version field. The versions must exist in the queue. JSON array
fixVersions Version IDs listed in the Fix Version field. The versions must exist in the queue. JSON array
components IDs of the components that apply to the issue. The components must exist in the queue. JSON array
tags Array of issue tags. JSON array
sprint IDs of the sprints that the issue is part of. JSON array
followers Array of IDs or usernames of issue followers. JSON array
access Array of IDs or usernames of users listed in the Access field. JSON array
unique Unique issue ID. You can set any ID. String
followingMaillists IDs of mailing lists (teams and departments subscribed to the issue). JSON array
originalEstimation Value of the "Original Estimate" parameter in milliseconds. Number
estimation Value of the "Estimate" parameter in milliseconds. Number
spent Value of the "Time Spent" parameter in milliseconds. Number
storyPoints Value of the Story Points parameter. Floating-point number
votedBy Array of IDs or usernames of users who voted for the issue. JSON array
favoritedBy Array of IDs or usernames of users who added the issue to favorites. JSON array

Example: Import an issue.

  • An HTTP POST method is used.
  • All additional fields are displayed in the response.
POST /v2/issues/_import
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>

{
 "queue": "TEST",
 "summary": "Test",
 "key": "TEST-1",
 "createdAt": "2017-08-29T12:34:41.740+0000",
 "createdBy": 11********,
 "updatedAt": "2017-09-09T11:24:31.140+0000",
 "updatedBy": 11********,
 "resolvedAt": "2017-09-08T09:33:42.250+0000",
 "resolvedBy": 11********,
 "status": 17,
 "deadline": "2017-09-07",
 "resolution": 1,
 "type": 2,
 "description": "Test",
 "start": "2017-09-04",
 "end": "2017-09-07",
 "assignee": 11********,
 "priority": 3,
 "affectedVersions": [1, 2, 3],
 "fixVersions": [4, 5, 6],
 "components": [7, 8, 9],
 "tags": ["test", "tag"],
 "sprint": [1, 2, 3],
 "followers": [11********, 22********],
 "access": [11********, 22********],
 "unique": "issue_51827865998247********",
 "followingMaillists": ["test@test.yaconnect.com", "mail@test.yaconnect.com"],
 "originalEstimation": 3600000,
 "estimation": 3600000,
 "spent": 3600000,
 "storyPoints": 1.0,
 "votedBy": [11********, 22********],
 "favoritedBy": [11********, 22********]
}

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains the parameters of the attached file in JSON format:

{
  "self": "https://https://api.tracker.yandex.net/v2/issues/TEST-1",
  "id": "141b2ef1e4b036e9********",
  "key": "TEST-1",
  "version": 1,
  "summary": "Test",
  "originalEstimation": "P1H",
  "estimation": "P1H",
  "spent": "P1H",
  "updatedBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/11********",
    "id": "11********",
    "display": "Иван Иванов"
  },
  "resolvedAt": "2017-09-08T09:33:42.250+0000",
  "start": "2017-09-04",
  "resolvedBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/11********",
    "id": "11********",
    "display": "Ivan Ivanov"
  },
  "description": "Test",
  "followingMaillists": [
    {
      "self": "https://https://api.tracker.yandex.net/v2/maillists/test@test.yaconnect.com",
      "id": "test@test.yaconnect.com",
      "display": "test"
    },
    {
      "self": "https://https://api.tracker.yandex.net/v2/maillists/mail@test.yaconnect.com",
      "id": "mail@test.yaconnect.com",
      "display": "mail"
    }
  ],
  "fixVersions": [
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/4",
      "id":"4",
      "display":"Version 4"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/5",
      "id":"5",
      "display":"Version 5"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/6",
      "id":"6",
      "display":"Version 6"
    }
  ],
  "type": {
    "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
    "id": "2",
    "key": "task",
    "display": "Task"
  },
  "priority": {
    "self":"https://https://api.tracker.yandex.net/v2/priorities/3",
    "id":"3",
    "key":"normal",
    "display":"Normal"
  },
  "resolution": {
    "self":"https://https://api.tracker.yandex.net/v2/resolutions/1",
    "id":"1",
    "key":"fixed",
    "display":"Fixed"
  },
  "createdAt": "2017-08-29T12:34:41.740+0000",
  "followers": [
    {
      "self": "https://https://api.tracker.yandex.net/v2/users/11********",
      "id": "11********",
      "display": "Ivan Ivanov"
    },
    {
      "self": "https://https://api.tracker.yandex.net/v2/users/22********",
      "id": "22********",
      "display": "Petr Petrov"
    }
  ],
  "assignee": {
    "self": "https://https://api.tracker.yandex.net/v2/users/11********",
    "id": "11********",
    "display": "Ivan Ivanov"
  },
  "createdBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/11********",
    "id": "11********",
    "display": "Ivan Ivanov"
  },
  "commentWithoutExternalMessageCount": 0,
  "votes": 0,
  "affectedVersions": [
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/1",
      "id":"1",
      "display":"Version 1"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/2",
      "id":"2",
      "display":"Version 2"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/versions/3",
      "id":"3",
      "display":"Version 3"
    }
  ],
  "commentWithExternalMessageCount": 0,
  "end": "2017-09-07",
  "deadline": "2018-05-28",
  "queue": {
    "self": "https://https://api.tracker.yandex.net/v2/queues/TEST",
    "id": "1",
    "key": "TEST",
    "display": "Test"
  },
  "updatedAt": "2017-09-09T11:24:31.140+0000",
  "storyPoints": 1.0,
  "status": {
    "self": "https://https://api.tracker.yandex.net/v2/statuses/17",
    "id": "17",
    "key": "closed",
    "display": "Closed"
  },
  "components":[
    {
      "self":"https://https://api.tracker.yandex.net/v2/components/7",
      "id":"7",
      "display":"Component 7"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/components/8",
      "id":"8",
      "display":"Component 8"
    },
    {
      "self":"https://https://api.tracker.yandex.net/v2/components/9",
      "id":"9",
      "display":"Component 9"
    }
  ],
  "access": [
    {
      "self": "https://https://api.tracker.yandex.net/v2/users/11********",
      "id": "11********",
      "display": "Ivan Ivanov"
    },
    {
      "self": "https://https://api.tracker.yandex.net/v2/users/22********",
      "id": "22********",
      "display": "Petr Petrov"
    }
  ],
  "unique": "issue_51827865998247********",
  "favorite": false
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue. String
id Address of the API resource with information about the issue. String
key Issue key. String
version Issue version. Each change to the issue parameters increases its version number. Number
summary Issue name. String
originalEstimation Value of the "Original Estimate" parameter. String
estimation Value of the "Estimate" parameter. String
spent Value of the "Time Spent" parameter. String
updatedBy Object with information about the user who edited the issue last. Object
resolvedAt Date and time of the resolution. String
start Date when work on the issue started. String
resolvedBy Object with information about the user who added the resolution. Object
description Issue description. String
followingMaillists Array of objects with information about mailing lists (teams and departments subscribed to the issue). Array of objects
fixVersions Versions listed in the "Fix Version" field. JSON array
type Issue type. JSON array
priority Object with information about the priority. Object
resolution Object with information about the resolution. Object
createdAt Issue creation date and time. String
followers Array of objects with information about issue followers. Array of objects
assignee Array of objects with information about the assignee. Array of objects
createdBy Array of objects with information about the issue author. Array of objects
affectedVersions Versions listed in the "Affected Versions" field. JSON array
queue Object with information about the queue that the issue belongs to. Object
status Object with information about the issue status. Object
components Array of objects with information about the components of the issue. Array of objects
access Array of objects with information about the users listed in the "Access" field. Array of objects
commentWithoutExternalMessageCount Number of comments on the issue. Number
votes Number of votes for the issue. Number
commentWithExternalMessageCount Number of messages sent from the issue page. Number
end Date when work on the issue was completed. String
deadline Deadline String
updatedAt Date and time when the issue was last updated. String
storyPoints Value of the Story Points parameter. Floating-point number
unique Unique ID of the issue that was set when importing it. String
favorite Shows if the user added the issue to favorites
  • true: Yes.
  • false: No.
 Logical

updatedBy object fields

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

resolvedBy object fields

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

followingMaillists object fields

Parameter Description Data type
self Address of the API resource with information about the mailing list. String
id Mailing list ID. String
display Mailing list name displayed. String

fixVersions object fields

Parameter Description Data type
self Address of the API resource with information about the version. String
id Version ID. String
display Version 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

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

resolution object fields

Parameter Description Data type
self Address of the API resource with information about the resolution. String
id Resolution ID. String
key Resolution key. String
display Resolution name displayed. String

followers object fields

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

assignee object fields

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

createdBy object fields

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

affectedVersions object fields

Parameter Description Data type
self Address of the API resource with information about the version. String
id Version ID. String
display Version name. String

queue object fields

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. String

status object fields

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

components object fields

Parameter Description Data type
self Address of the API resource with information about the component. String
id Component ID. String
key Component key. String
display Component name displayed. String

access object fields

Parameter Description Data type
self Address of the API resource with information about the version. String
id Version ID. String
display Version name. 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.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
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.
Previous
Getting a list of components
Next
Importing files