Items - Get

リファレンス

Service:: Git

API Version:: 4.1

1 つのアイテムのアイテムメタデータやコンテンツを取得します。 download パラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 zip 形式のコンテンツには適用されません。これは常にダウンロードとして返されます。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=4.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.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&api-version=4.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
repositoryId	path	True	string	リポジトリの ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '4.1' に設定する必要があります。
path	query	True	string	項目のパス。
$format	query		string	指定すると、HTTP Accept 要求ヘッダーがオーバーライドされ、'json' または 'zip' が返されます。 $formatが指定されている場合は、api-version もクエリパラメーターとして指定する必要があります。
download	query		boolean	応答をファイルとしてダウンロードするには、true に設定します。既定値は false です。
includeContent	query		boolean	json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。
includeContentMetadata	query		boolean	コンテンツメタデータを含めるには、true に設定します。既定値は false です。
latestProcessedChange	query		boolean	最後の変更を含めるには、true に設定します。既定値は false です。
recursionLevel	query		VersionControlRecursionType	この要求の再帰レベル。既定値は 'none' で、再帰はありません。
scopePath	query		string	パススコープ。既定値は null です。
versionDescriptor.version	query		string	バージョン文字列識別子 (タグ/ブランチの名前、コミットの SHA1)
versionDescriptor.versionOptions	query		GitVersionOptions	バージョンオプション - バージョンに対して追加の修飾子を指定します (例: Previous)
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=4.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=4.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	オブジェクトの種類 (Commit、Tree、Blob、Tag)
GitStatus	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。
GitStatusContext	状態を一意に識別する状態コンテキスト。
GitStatusState	状態の状態。
GitTemplate
GitUserDate	Git 操作のユーザー情報と日付。
GitVersionOptions	バージョンオプション - バージョンに追加の修飾子を指定します (例: Previous)
GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ResourceRef
VersionControlChangeType	アイテムに対して行われた変更の種類。
VersionControlRecursionType	子 (OneLevel)、すべての子孫 (Full)、または None を含めるかどうかを指定します

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)。
committer	GitUserDate	コミットのコミッター。
parents	string[]	このコミットの親コミット ID の列挙。
remoteUrl	string	コミットへのリモート URL パス。
statuses	GitStatus[]	コミットに追加情報を関連付ける可能性があるサービスと拡張機能からの状態メタデータの一覧。
url	string	このリソースの REST URL。
workItems	ResourceRef[]	このコミットに関連付けられている作業項目の一覧。

GitItem

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
commitId	string	コミット項目の SHA1 がでフェッチされました
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	オブジェクトの種類 (Commit、Tree、Blob、Tag、...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	最後に変更されたこのアイテムをコミットするための浅い参照 latestProcessedChange が要求された場合にのみ設定される最新の変更がまだキャッシュされていない場合は正確ではない可能性があります
objectId	string	Git オブジェクト ID
originalObjectId	string	Git オブジェクト ID
path	string
url	string

GitObjectType

オブジェクトの種類 (Commit、Tree、Blob、Tag)

名前	型	説明
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitStatus

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。

名前	型	説明
_links	ReferenceLinks	参照リンク。
context	GitStatusContext	状態のコンテキスト。
createdBy	IdentityRef	状態を作成した ID。
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	git 操作を実行しているユーザーのアドレスをEmailします。
name	string	Git 操作を実行しているユーザーの名前。

GitVersionOptions

バージョンオプション - バージョンに追加の修飾子を指定します (例: Previous)

名前	型	説明
firstParent	string	コミットの最初の親 (HEAD^)
none	string	指定なし
previousChange	string	変更されたアイテムを現在のバージョンより前にコミットする

GitVersionType

バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します

名前	型	説明
branch	string	バージョンをブランチ名として解釈する
commit	string	バージョンをコミット ID (SHA1) として解釈する
tag	string	バージョンをタグ名として解釈する

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
profileUrl	string
uniqueName	string
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)、または None を含めるかどうかを指定します

名前	型	説明
full	string	指定された項目とすべての子孫を返します
none	string	指定した項目のみを返します。
oneLevel	string	指定した項目とその直接の子を返します。
oneLevelPlusNestedEmptyFolders	string	指定した項目とその直接の子、および 1 つのフォルダーのみを含む入れ子になった子フォルダーの再帰的なチェーンを返します。

Items - Get

URI パラメーター

応答

セキュリティ

oauth2

Scopes

例

Download

Sample Request

Sample Response

Get metadata

Sample Request

Sample Response

定義

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType

フィードバック

その他のリソース