Developer Portal for YouTrack and Hub Help

Issue VCS Changes

This resource lets you work with the VCS changes linked to an issue.

Resource

/api/issues/{issueID}/vcsChanges

Returned entity

VcsChange. For the description of the entity attributes, see Supported Fields section.

Supported methods

VcsChange attributes

Represents a VCS change linked to an issue.

This table describes attributes of the VcsChange entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The database ID of the VCS change. Read-only.

date

Long

The date when the VCS change was committed to the repository. Read-only. Can be null.

fetched

Long

The date when the VCS change was fetched from the repository to YouTrack. Read-only. Can be null.

files

Int

The number of files included into the VCS change. Equals -1 if the number of files is unknown. Read-only.

author

User

The author of the VCS change. Read-only.

processors

Array of ChangesProcessors

The list of version control systems that contain the VCS change. Read-only.

text

String

The commit message of the VCS change. Read-only. Can be null.

urls

Array of Strings

The list of links to the VCS change in the corresponding version control systems. The order is the same as in the processors attribute. Read-only.

version

String

The commit hash of the VCS change. Can be null.

issue

Issue

The YouTrack issue the VCS change is linked to. Can be null.

state

Byte

The code of the state of the VCS change. Here is the list of available state codes:

  • 0 = default

  • 1 = attached manually

  • 2 = detached

  • 3 = legacy

The list of state codes may be extended in the future API versions.

Read a List of VcsChanges

Get all accessible VCS changes linked to the specific issue.

Required permissions

Requires:

  1. Read access to the issue.

  2. Group membership in one of the groups in the "VCS changes visibility" setting in the VCS integration settings.

Request syntax

GET /api/issues/{issueID}/vcsChanges?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

A list of VcsChange attributes that should be returned in the response. If no field is specified, only the entityID is returned.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response.

Sample

Sample request

https://example.youtrack.cloud/api/issues/NP-5/vcsChanges?fields=id,date,fetched,files,author(login),text,version,state

Sample response body

[ { "version": "4f193a6de41c65245a3a044f568604137f1ecc09", "date": 1495443753000, "state": 0, "files": -1, "author": { "login": "jane.doe", "$type": "User" }, "fetched": null, "text": "#NP-5 In Progress", "id": "127-3", "$type": "VcsChange" }, { "version": "22bce6953b1b63c18c333efbd245a4382326b95d", "date": 1495443805000, "state": 2, "files": -1, "author": { "login": "jane.doe", "$type": "User" }, "fetched": null, "text": " #NP-5 Open", "id": "127-4", "$type": "VcsChange" }, { "version": "8174a198e670d36a649f3b4a12ab55ac88c78f71", "date": 1564484957000, "state": 1, "files": -1, "author": { "login": "system_user@iSoHnĐťAu9X", "$type": "VcsUnresolvedUser" }, "fetched": 1640085901059, "text": "Update \n\n#NP-5 fix the issue", "id": "127-23", "$type": "VcsChange" } ]

Add a New VcsChange

Link a new VCS change to an issue with a specific ID.

Required permissions

Requires permissions: Update Issue Private Fields

Request syntax

POST /api/issues/{issueID}/vcsChanges?{fields}&{muteUpdateNotifications}

Request parameters

Parameter

Type

Description

fields

String

A list of VcsChange attributes that should be returned in the response. If no field is specified, only the entityID is returned.

muteUpdateNotifications

Boolean

Set this parameter to true if no notifications should be sent on issue changes caused by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3.

Sample

Sample request

https://example.youtrack.cloud/api/issues/NP-5/vcsChanges?fields=id,date,fetched,files,author(login),text,version,state

Sample request body

{ "version": "03e876865ba4388205ac11788c6595f5ba8387a4", "state": 1 }

Sample response body

{ "version": "03e876865ba4388205ac11788c6595f5ba8387a4", "date": 1642167090000, "state": 1, "files": -1, "author": { "login": "jane.doe", "$type": "User" }, "fetched": 1642167188839, "text": "Update Test.txt", "id": "127-27", "$type": "VcsChange" }
Last modified: 9 May 2022