YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Resources for Developers
  2. REST API
  3. REST API Use Cases
  4. Create an Issue

Create an Issue

Last modified: 17 December 2019

Use Case:

Use the REST API to create a new issue with the default values for issue custom fields.

note

Please notice that this example is valid for YouTrack 2019.1 and later versions. In the previous versions, though the principle is the same, query parameters and entity attributes may differ. Also, a number of features, like addressing an entity by its name, were introduced in 2019.1 and are not supported in the previous versions.

Summary

To create an issue, you need to know an entity id of the project to which the issue should be reported. It means that you need to get a list of available projects, find an id of the target project, and then create a new issue in this project.

Step-by-Step

  1. Get a list of available projects.

    curl -X GET \
'https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,name,shortName' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:amFuZS5kb2U=.UkVTVCBBUEk=.wcKuAok8cHmAtzjA6xlc4BrB4hleaX' \
-H 'Content-Type: application/json'

    For such request, you get response from the server with the following body:

    [
    {
        "shortName": "GRP",
        "name": "GRA Project",
        "id": "0-7",
        "$type": "Project"
    },
    {
        "shortName": "RAP",
        "name": "Rest Api Project",
        "id": "0-2",
        "$type": "Project"
    },
    {
        "shortName": "RP",
        "name": "Rest Project",
        "id": "0-6",
        "$type": "Project"
    },
    {
        "shortName": "SP",
        "name": "Sample Project",
        "id": "0-0",
        "$type": "Project"
    },
    {
        "shortName": "SNBX",
        "name": "Sandbox",
        "id": "0-3",
        "$type": "Project"
    }
]

    You can also filter the list of projects by shortName or a name of the required project.

    Sample request with the filter by a project's name: 

    curl -X GET \
'https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,name,shortName&query=Sample+Project'
\
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:amFuZS5kb2U=.UkVTVCBBUEk=.wcKuAok8cHmAtzjA6xlc4BrB4hleaX' \
-H 'Content-Type: application/json'

    Sample request with the filter by a project's shortName: 

    curl -X GET \
'https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,name,shortName&query=sp'
\
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:amFuZS5kb2U=.UkVTVCBBUEk=.wcKuAok8cHmAtzjA6xlc4BrB4hleaX' \
-H 'Content-Type: application/json'

    To the sample request with the query parameter, the response body contains data only for the matching project: 

    [
    {
        "shortName": "SP",
        "name": "Sample Project",
        "id": "0-0",
        "$type": "Project"
    }
]

  2. In the response from the server, locate the id of the target project. In our sample, the required project id is 0-0. 

    "id" : "0-0"

  3. Send a POST request to create a new issue in the target project: 

    curl -X POST \
https://example.myjetbrains.com/youtrack/api/issues \
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:amFuZS5kb2U=.UkVTVCBBUEk=.wcKuAok8cHmAtzjA6xlc4BrB4hleaX' \
-H 'Content-Type: application/json' \
-d '{
"project":{"id":"0-0"},
"summary":"REST API lets you create issues!",
"description":"Let'\''s create a new issue using YouTrack'\''s REST API."
}'

    In the body of the response, the server returns the entity id of the created issue:

    {
    "id": "2-38",
    "$type": "Issue"
}

That's it: We created a new issue. All custom fields of the issue are set to their default values.

note

Please note that you cannot simultaneously create a new issue and add attachments to it. You can attach files only to an already existing issue.