Changesets - Create

参考

服务:: Tfvc

API 版本:: 7.1

创建新的变更集。

接受 TfvcChangeset 作为 JSON 正文

POST https://dev.azure.com/{organization}/{project}/_apis/tfvc/changesets?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	REST 引用链接的集合。
accountId	string (uuid)	变更集帐户 ID 也称为组织 ID。
author	IdentityRef	用户的别名或显示名称。
changes	TfvcChange[]	关联的更改列表。
changesetId	integer (int32)	更改集 ID。
checkedInBy	IdentityRef	用户的别名或显示名称。
checkinNotes	CheckinNote[]	更改集的 Checkin 备注列表。
collectionId	string (uuid)	更改集集合 ID。
comment	string	更改集的注释。
commentTruncated	boolean	注释结果是否已截断？
createdDate	string (date-time)	更改集的创建日期。
hasMoreChanges	boolean	如此如果有更多更改可用。
policyOverride	TfvcPolicyOverrideInfo	更改集的策略替代。
teamProjectIds	string[] (uuid)	更改集的团队项目 ID。
url	string	用于检索项的 URL。
workItems	AssociatedWorkItem[]	与变更集关联的工作项列表。

响应

名称	类型	说明
200 OK	TfvcChangesetRef	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.code_write	授予读取、更新和删除源代码、访问有关提交、更改集、分支和其他版本控制项目的元数据的能力。此外，还授予创建和管理拉取请求和代码评审以及通过服务挂钩接收有关版本控制事件的通知的能力。

示例

POST a file edit changeset.

POST an add binary file changeset.

POST an add multiple file changeset.

POST an add text file changeset.

POST a file edit changeset.

示例请求

HTTP

POST https://dev.azure.com/{organization}/_apis/tfvc/changesets?api-version=7.1

{
  "changes": [
    {
      "item": {
        "version": 7,
        "path": "$/Project01/file-to-edit-2019-04-09-23-21-13-31.txt",
        "contentMetadata": {
          "encoding": 1200,
          "contentType": "text/plain"
        }
      },
      "changeType": "edit",
      "newContent": {
        "content": "Initial contents as of 4/9/2019 11:21:13 PM\nEdited contents"
      }
    }
  ],
  "comment": "(sample) Editing the file via API"
}

示例响应

状态代码:: 201

{
  "checkinNotes": [],
  "policyOverride": {
    "policyFailures": []
  },
  "changesetId": 8,
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/8",
  "author": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "checkedInBy": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "createdDate": "2019-04-09T23:21:27.197Z",
  "comment": "(sample) Editing the file via API"
}

POST an add binary file changeset.

示例请求

HTTP

POST https://dev.azure.com/{organization}/_apis/tfvc/changesets?api-version=7.1

{
  "changes": [
    {
      "item": {
        "path": "$/Project01/testzip.zip",
        "contentMetadata": {
          "encoding": -1
        }
      },
      "changeType": "add",
      "newContent": {
        "content": "UEsDBAoAAAAAAPxQJk8Mfn/YBAAAAAQAAAAIAAAAdGVzdC50eHR0ZXN0UEsBAj8ACgAAAAAA/FAmTwx+f9gEAAAABAAAAAgAJAAAAAAAAAAgAAAAAAAAAHRlc3QudHh0CgAgAAAAAAABABgAHDH5ebxk1QEcMfl5vGTVAe/BonO8ZNUBUEsFBgAAAAABAAEAWgAAACoAAAAAAA==",
        "contentType": "base64Encoded"
      }
    }
  ],
  "comment": "(sample) Adding a new changeset via API"
}

示例响应

状态代码:: 201

{
  "checkinNotes": [],
  "policyOverride": {
    "policyFailures": []
  },
  "changesetId": 5,
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/5",
  "author": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "checkedInBy": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "createdDate": "2019-04-09T23:20:51.94Z",
  "comment": "(sample) Adding a new changeset via API"
}

POST an add multiple file changeset.

示例请求

HTTP

POST https://dev.azure.com/{organization}/_apis/tfvc/changesets?api-version=7.1

{
  "changes": [
    {
      "item": {
        "path": "$/Project01/example-file-2019-04-09-23-21-00-40.1.txt",
        "contentMetadata": {
          "encoding": 1200
        }
      },
      "changeType": "add",
      "newContent": {
        "content": "File 1 contents as of 4/9/2019 11:21:00 PM",
        "contentType": "rawText"
      }
    },
    {
      "item": {
        "path": "$/Project01/example-file-2019-04-09-23-21-00-40.2.txt",
        "contentMetadata": {
          "encoding": 1200
        }
      },
      "changeType": "add",
      "newContent": {
        "content": "File 2 contents as of 4/9/2019 11:21:00 PM",
        "contentType": "rawText"
      }
    }
  ],
  "comment": "(sample) Adding multiple files via API"
}

示例响应

状态代码:: 201

{
  "checkinNotes": [],
  "policyOverride": {
    "policyFailures": []
  },
  "changesetId": 6,
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/6",
  "author": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "checkedInBy": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "createdDate": "2019-04-09T23:21:11.55Z",
  "comment": "(sample) Adding multiple files via API"
}

POST an add text file changeset.

示例请求

HTTP

POST https://dev.azure.com/{organization}/_apis/tfvc/changesets?api-version=7.1

{
  "changes": [
    {
      "item": {
        "path": "$/Project01/example-file-2019-04-09-23-20-28-70.txt",
        "contentMetadata": {
          "encoding": 1200
        }
      },
      "changeType": "add",
      "newContent": {
        "content": "File contents as of 4/9/2019 11:20:28 PM",
        "contentType": "rawText"
      }
    }
  ],
  "comment": "(sample) Adding a new changeset via API"
}

示例响应

状态代码:: 201

{
  "checkinNotes": [],
  "policyOverride": {
    "policyFailures": []
  },
  "changesetId": 5,
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/changesets/5",
  "author": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "checkedInBy": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "createdDate": "2019-04-09T23:20:51.94Z",
  "comment": "(sample) Adding a new changeset via API"
}

定义

名称	说明
AssociatedWorkItem
CheckinNote
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	表示 REST 引用链接集合的类。
TfvcChange	更改。
TfvcChangeset	更改的集合。
TfvcChangesetRef	变更集的元数据。
TfvcMergeSource
TfvcPolicyFailureInfo	策略失败信息。
TfvcPolicyOverrideInfo	有关策略替代的信息。
VersionControlChangeType	对项所做的更改的类型。

AssociatedWorkItem

Object

名称	类型	说明
assignedTo	string
id	integer (int32)	关联的工作项的 ID。
state	string
title	string
url	string	工作项的 REST URL。
webUrl	string
workItemType	string

CheckinNote

Object

名称	类型	说明
name	string
value	string

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

ItemContent

Object

名称	类型	说明
content	string
contentType	ItemContentType

ItemContentType

枚举

值	说明
base64Encoded
rawText

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

TfvcChange

Object

更改。

名称	类型	说明
changeType	VersionControlChangeType	对项所做的更改的类型。
item	string (T)	当前版本。
mergeSources	TfvcMergeSource[]	重命名或分支创建时合并源的列表。
newContent	ItemContent	更改后项的内容。
pendingVersion	integer (int32)	版本（搁置）更改被笔触
sourceServerItem	string	服务器上的项的路径。
url	string	用于检索项的 URL。

TfvcChangeset

Object

更改的集合。

名称	类型	说明
_links	ReferenceLinks	REST 引用链接的集合。
accountId	string (uuid)	变更集帐户 ID 也称为组织 ID。
author	IdentityRef	用户的别名或显示名称。
changes	TfvcChange[]	关联的更改列表。
changesetId	integer (int32)	更改集 ID。
checkedInBy	IdentityRef	用户的别名或显示名称。
checkinNotes	CheckinNote[]	更改集的 Checkin 备注列表。
collectionId	string (uuid)	更改集集合 ID。
comment	string	更改集的注释。
commentTruncated	boolean	注释结果是否已截断？
createdDate	string (date-time)	更改集的创建日期。
hasMoreChanges	boolean	如此如果有更多更改可用。
policyOverride	TfvcPolicyOverrideInfo	更改集的策略替代。
teamProjectIds	string[] (uuid)	更改集的团队项目 ID。
url	string	用于检索项的 URL。
workItems	AssociatedWorkItem[]	与变更集关联的工作项列表。

TfvcChangesetRef

Object

变更集的元数据。

名称	类型	说明
_links	ReferenceLinks	REST 引用链接的集合。
author	IdentityRef	用户的别名或显示名称。
changesetId	integer (int32)	更改集 ID。
checkedInBy	IdentityRef	用户的别名或显示名称。
comment	string	更改集的注释。
commentTruncated	boolean	注释结果是否已截断？
createdDate	string (date-time)	更改集的创建日期。
url	string	用于检索项的 URL。

TfvcMergeSource

Object

名称	类型	说明
isRename	boolean	指示此名称是否为重命名源。如果为 false，则为合并源。
serverItem	string	合并源的服务器项。
versionFrom	integer (int32)	版本范围的开始。
versionTo	integer (int32)	版本范围的结束。

TfvcPolicyFailureInfo

Object

策略失败信息。

名称	类型	说明
message	string	策略失败消息。
policyName	string	失败的策略的名称。

TfvcPolicyOverrideInfo

Object

有关策略替代的信息。

名称	类型	说明
comment	string	超额策略注释。
policyFailures	TfvcPolicyFailureInfo[]	有关被重写的失败策略的信息。

VersionControlChangeType

枚举

对项所做的更改的类型。

值	说明
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

通过

Changesets - Create

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

POST a file edit changeset.

示例请求

示例响应

POST an add binary file changeset.

示例请求

示例响应

POST an add multiple file changeset.

示例请求

示例响应

POST an add text file changeset.

示例请求

示例响应

定义

AssociatedWorkItem

CheckinNote

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

TfvcChange

TfvcChangeset

TfvcChangesetRef

TfvcMergeSource

TfvcPolicyFailureInfo

TfvcPolicyOverrideInfo

VersionControlChangeType

其他资源