Changesets - Get Batched Changesets
Returns changesets for a given list of changeset Ids.
POST https://dev.azure.com/{organization}/_apis/tfvc/changesetsbatch?api-version=6.0URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0' to use this version of the api. |
Request Body
| Name | Type | Description |
|---|---|---|
| changesetIds |
integer[] |
List of changeset Ids. |
| commentLength |
integer |
Max length of the comment. |
| includeLinks |
boolean |
Whether to include the _links field on the shallow references |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| Name | Description |
|---|---|
| vso.code | Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks. |
Examples
Returns the Tfvc changes for a given set of changes
Sample Request
POST https://dev.azure.com/{organization}/_apis/tfvc/changesetsbatch?api-version=6.0
{
"changesetIds": [
7,
6
],
"commentLength": 50,
"includeLinks": true
}
Sample Response
{
"count": 2,
"value": [
{
"changesetId": 7,
"url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/7",
"author": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"uniqueName": "fabrikamfiber3@hotmail.com",
"imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"checkedInBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"uniqueName": "fabrikamfiber3@hotmail.com",
"imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"createdDate": "2019-05-28T18:44:26.103Z",
"comment": "Updated TestFile01.txt",
"_links": {
"self": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/7"
},
"changes": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/7/changes"
},
"workItems": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/7/workItems"
},
"web": {
"href": "https://codedev.ms/fabrikam/Project01/_versionControl/changeset/7"
},
"author": {
"href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"checkedInBy": {
"href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
}
}
},
{
"changesetId": 6,
"url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/6",
"author": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"uniqueName": "fabrikamfiber3@hotmail.com",
"imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"checkedInBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"uniqueName": "fabrikamfiber3@hotmail.com",
"imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"createdDate": "2019-05-24T17:44:05.243Z",
"comment": "Branch ExampleFolder",
"_links": {
"self": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/6"
},
"changes": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/6/changes"
},
"workItems": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/6/workItems"
},
"web": {
"href": "https://codedev.ms/fabrikam/Project01/_versionControl/changeset/6"
},
"author": {
"href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"checkedInBy": {
"href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
}
}
}
]
}Definitions
| Name | Description |
|---|---|
|
Identity |
|
|
Reference |
The class to represent a collection of REST reference links. |
|
Tfvc |
Metadata for a changeset. |
|
Tfvc |
Request body for Get batched changesets. |
IdentityRef
| Name | Type | Description |
|---|---|---|
| _links |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
| descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
| directoryAlias |
string |
Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary |
| displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
| id |
string |
|
| imageUrl |
string |
Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary |
| inactive |
boolean |
Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary |
| isAadIdentity |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Deprecated - not in use in most preexisting implementations of ToIdentityRef |
| uniqueName |
string |
Deprecated - use Domain+PrincipalName instead |
| url |
string |
This url is the full route to the source resource of this graph subject. |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
TfvcChangesetRef
Metadata for a changeset.
| Name | Type | Description |
|---|---|---|
| _links |
A collection of REST reference links. |
|
| author |
Alias or display name of user. |
|
| changesetId |
integer |
Changeset Id. |
| checkedInBy |
Alias or display name of user. |
|
| comment |
string |
Comment for the changeset. |
| commentTruncated |
boolean |
Was the Comment result truncated? |
| createdDate |
string |
Creation date of the changeset. |
| url |
string |
URL to retrieve the item. |
TfvcChangesetsRequestData
Request body for Get batched changesets.
| Name | Type | Description |
|---|---|---|
| changesetIds |
integer[] |
List of changeset Ids. |
| commentLength |
integer |
Max length of the comment. |
| includeLinks |
boolean |
Whether to include the _links field on the shallow references |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for