Items - Get

参考

Service:: Git

API Version:: 7.1-preview.1

获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&scopePath={scopePath}&recursionLevel={recursionLevel}&includeContentMetadata={includeContentMetadata}&latestProcessedChange={latestProcessedChange}&download={download}&$format={$format}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&resolveLfs={resolveLfs}&sanitize={sanitize}&api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
repositoryId	path	True	string	存储库的名称或 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。
path	query	True	string	项路径。
$format	query		string	如果指定，这将替代 HTTP Accept 请求标头以返回“json”或“zip”。如果指定了$format，则还应将 api-version 指定为查询参数。
download	query		boolean	设置为 true 以文件的形式下载响应。默认值为 false。
includeContent	query		boolean	设置为 true 以在请求 json 时包含项内容。默认值为 false。
includeContentMetadata	query		boolean	设置为 true 以包含内容元数据。默认值为 false。
latestProcessedChange	query		boolean	设置为 true 以包含最新更改。默认值为 false。
recursionLevel	query		VersionControlRecursionType	此请求的递归级别。默认值为“none”，无递归。
resolveLfs	query		boolean	设置为 true 可解析 Git LFS指针文件，以从 Git LFS返回实际内容。默认值为 false。
sanitize	query		boolean	设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。
scopePath	query		string	路径范围。默认值为 NULL。
versionDescriptor.version	query		string	版本字符串标识符 (标记/分支的名称，提交) 的 SHA1
versionDescriptor.versionOptions	query		GitVersionOptions	版本选项 - 指定版本 (的其他修饰符，例如上一)
versionDescriptor.versionType	query		GitVersionType	版本类型 (分支、标记或提交) 。确定如何解释 ID

响应

名称	类型	说明
200 OK	GitItem	成功的操作 Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

名称

类型

说明

200 OK

GitItem

成功的操作

Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

安全性

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

名称	说明
vso.code	授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。此外，还授予搜索代码的功能，并通过服务挂钩获取有关版本控制事件的通知。

示例

Download

Get metadata

Download

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&download=true&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Get metadata

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

定义

名称	说明
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	提供描述 Git 提交和关联元数据的属性。
GitItem
GitObjectType	对象类型 (提交、树、Blob、标记)
GitPushRef
GitStatus	此类包含发布状态的服务/扩展的元数据。
GitStatusContext	唯一标识状态的状态上下文。
GitStatusState	状态的状态。
GitTemplate
GitUserDate	Git 操作的用户信息和日期。
GitVersionOptions	版本选项 - 为版本 (指定其他修饰符，例如上一个)
GitVersionType	版本类型 (分支、标记或提交) 。确定如何解释 ID
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	表示 REST 引用链接集合的类。
ResourceRef
VersionControlChangeType	对项所做的更改的类型。
VersionControlRecursionType	指定是包括 OneLevel) (子级、 (完整) 的所有后代还是无子级

ChangeCountDictionary

FileContentMetadata

名称	类型	说明
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

GitChange

名称	类型	说明
changeId	integer	更改组中更改的 ID。
changeType	VersionControlChangeType	对项所做的更改的类型。
item	string	当前版本。
newContent	ItemContent	更改后项的内容。
newContentTemplate	GitTemplate	推送新更改时要使用的新内容模板。
originalPath	string	项的原始路径（如果不同于当前路径）。
sourceServerItem	string	服务器上的项的路径。
url	string	用于检索项的 URL。

GitCommitRef

提供描述 Git 提交和关联元数据的属性。

名称	类型	说明
_links	ReferenceLinks	相关 REST 引用链接的集合。
author	GitUserDate	提交的作者。
changeCounts	ChangeCountDictionary	提交中包含的更改类型 (编辑、删除等) 计数。
changes	GitChange[]	提交中包含的更改的枚举。
comment	string	提交注释或消息。
commentTruncated	boolean	指示注释是否从完整的 Git 提交注释消息中截断。
commitId	string	提交的 ID (SHA-1) 。
commitTooManyChanges	boolean	指示提交包含太多无法显示的更改
committer	GitUserDate	提交的提交者。
parents	string[]	此提交的父提交 ID 的枚举。
push	GitPushRef	与此提交关联的推送。
remoteUrl	string	提交的远程 URL 路径。
statuses	GitStatus[]	来自服务和扩展的状态元数据的列表，这些元数据可能会将其他信息关联到提交。
url	string	此资源的 REST URL。
workItems	ResourceRef[]	与此提交关联的工作项列表。

GitItem

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
commitId	string	提交项的 SHA1 已提取到
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	对象类型 (提交、树、Blob、标记...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	浅层 ref to commit that last changed this item only populated if latestProcessedChange is requestedChange is requested 可能不准确（如果尚未缓存最新更改）
objectId	string	Git 对象 ID
originalObjectId	string	Git 对象 ID
path	string
url	string

GitObjectType

对象类型 (提交、树、Blob、标记)

名称	类型	说明
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

此类包含发布状态的服务/扩展的元数据。

名称	类型	说明
_links	ReferenceLinks	参考链接。
context	GitStatusContext	状态的上下文。
createdBy	IdentityRef	创建状态的标识。
creationDate	string	状态的创建日期和时间。
description	string	状态说明。通常描述状态的当前状态。
id	integer	状态标识符。
state	GitStatusState	状态的状态。
targetUrl	string	包含状态详细信息的 URL。
updatedDate	string	状态的上次更新日期和时间。

GitStatusContext

唯一标识状态的状态上下文。

名称	类型	说明
genre	string	状态的流派。生成状态的服务/工具的名称通常可以为空。
name	string	状态的名称标识符不能为 null 或空。

GitStatusState

状态的状态。

名称	类型	说明
error	string	出现错误的状态。
failed	string	状态失败。
notApplicable	string	状态不适用于目标对象。
notSet	string	状态状态未设置。默认状态。
pending	string	状态挂起。
succeeded	string	状态成功。

GitTemplate

名称	类型	说明
name	string	模板的名称
type	string	模板的类型

GitUserDate

Git 操作的用户信息和日期。

名称	类型	说明
date	string	Git 操作的日期。
email	string	Email执行 Git 操作的用户的地址。
imageUrl	string	用户头像的 URL。
name	string	执行 Git 操作的用户的名称。

GitVersionOptions

版本选项 - 为版本 (指定其他修饰符，例如上一个)

名称	类型	说明
firstParent	string	提交 (HEAD^) 的第一个父级
none	string	未指定
previousChange	string	在当前版本之前已更改项的提交

GitVersionType

版本类型 (分支、标记或提交) 。确定如何解释 ID

名称	类型	说明
branch	string	将版本解释为分支名称
commit	string	将版本解释为提交 ID (SHA1)
tag	string	将版本解释为标记名称

IdentityRef

名称	类型	说明
_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

名称	类型	说明
content	string
contentType	ItemContentType

ItemContentType

名称	类型	说明
base64Encoded	string
rawText	string

ReferenceLinks

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

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

ResourceRef

名称	类型	说明
id	string
url	string

VersionControlChangeType

对项所做的更改的类型。

名称	类型	说明
add	string
all	string
branch	string
delete	string
edit	string
encoding	string
lock	string
merge	string
none	string
property	string
rename	string
rollback	string
sourceRename	string
targetRename	string
undelete	string

VersionControlRecursionType

指定是包括 OneLevel) (子级、 (完整) 的所有后代还是无子级

名称	类型	说明
full	string	返回指定的项和所有后代
none	string	仅返回指定的项。
oneLevel	string	返回指定的项及其直接子项。
oneLevelPlusNestedEmptyFolders	string	返回指定项及其直接子级，以及仅包含单个文件夹的嵌套子文件夹的递归链。

通过

Items - Get

URI 参数

响应

安全性

oauth2

Scopes

示例

Download

Sample Request

Sample Response

Get metadata

Sample Request

Sample Response

定义

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType

其他资源