Operations with Specific Issue VCS Changes
This resource lets you work with the VCS changes linked to an issue.
Resource | |
|---|---|
Returned entity | VcsChange. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents a VCS change linked to an issue.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the VcsChange entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest 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. |
date | Long | The date when the VCS change was committed to the repository. |
fetched | Long | The date when the VCS change was fetched from the repository to YouTrack. |
files | Int | The number of files included into the VCS change. Equals -1 if the number of files is unknown. |
author | The author of the VCS change. | |
processors | The list of version control systems that contain the VCS change. | |
text | String | The commit message of the VCS change. |
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 |
version | String | The commit hash of the VCS change. |
issue | The YouTrack issue the VCS change is linked to. | |
state | Byte | The code of the state of the VCS change. Here is the list of available state codes:
The list of state codes may be extended in the future API versions. |
Read a VCS change with a specific ID.
Requires:
Read access to the issue.
Group membership in one of the groups in the "VCS changes visibility" setting in the VCS integration settings.
GET /api/issues/{issueID}/vcsChanges/{changeID}?{fields}{changeID} | The database ID of the VCS change. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of VcsChange attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/NP-5/vcsChanges/127-26?fields=id,date,fetched,files,author(login),text,urls,version,state{
"version": "608e511cac30d0d6ec85fac6ae246ac88a16f2a1",
"date": 1642067804000,
"state": 1,
"files": -1,
"author": {
"login": "john.smith",
"$type": "User"
},
"fetched": 1642067825847,
"text": "fix the bug",
"id": "127-26",
"$type": "VcsChange"
}Update an existing VCS change in the specific issue. You can only update the state of the change.
Requires Update Issue Private Fields permission.
POST /api/issues/{issueID}/vcsChanges/{changeID}?{fields}&{muteUpdateNotifications}{changeID} | The database ID of the VCS change. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of VcsChange attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | Set this parameter to |
https://example.youtrack.cloud/api/issues/NP-5/vcsChanges/127-27?fields=id,date,fetched,author(login),text,version,state{"state": 2}{
"version": "03e876865ba4388205ac11788c6595f5ba8387a4",
"date": 1642167090000,
"state": 2,
"author": {
"login": "jane.doe",
"$type": "User"
},
"fetched": 1642167188839,
"text": "fix the bug",
"id": "127-27",
"$type": "VcsChange"
}Detach the specific VCS change from the specific issue.
Requires Update Issue Private Fields permission.
DELETE /api/issues/{issueID}/vcsChanges/{changeID}{changeID} | The database ID of the VCS change. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of VcsChange attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/NP-5/vcsChanges/127-27