Items - Get

リファレンス

Service:: Tfvc

API Version:: 7.1-preview.1

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

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&fileName={fileName}&download={download}&scopePath={scopePath}&recursionLevel={recursionLevel}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOption={versionDescriptor.versionOption}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
path	query	True	string	返す個々の項目のバージョン管理パス。
download	query		boolean	true の場合は、ダウンロード可能な添付ファイルを作成します。
fileName	query		string	返されるアイテムのファイル名。
includeContent	query		boolean	json を要求するときに項目の内容を含めるには、true に設定します。既定値は false です。
recursionLevel	query		VersionControlRecursionType	None (アイテムのみ)、または OneLevel (フォルダーの内容)。
scopePath	query		string	複数の項目を返すフォルダーのバージョン管理パス。
versionDescriptor.version	query		string	Version オブジェクトです。
versionDescriptor.versionOption	query		TfvcVersionOption	バージョン記述子。既定値は Null です。
versionDescriptor.versionType	query		TfvcVersionType	バージョン記述子。既定値は Null です。

応答

名前	型	説明
200 OK	TfvcItem	成功した操作 Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

名前

型

説明

200 OK

TfvcItem

成功した操作

Media Types: "text/plain", "application/octet-stream", "application/zip", "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	コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソースコードとメタデータを読み取る機能を付与します。また、サービスフックを使用してコードを検索し、バージョン管理イベントに関する通知を受け取る機能も付与されます。

例

GET item metadata and/or content for a single item.

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "version": 10,
  "changeDate": "2019-05-29T18:00:23.457Z",
  "size": 4,
  "hashValue": "CY9rzUYh03PK3k6DJie09g==",
  "encoding": 65001,
  "path": "$/MyFirstProject/ExampleFolder/TestFile01.txt",
  "contentMetadata": {
    "encoding": 65001,
    "contentType": "text/plain",
    "fileName": "TestFile01.txt",
    "extension": ".txt",
    "vsLink": "vsweb://vs/?Product=Visual_Studio&Gen=2013&EncFormat=UTF8&tfslink=dnN0ZnM6Ly8vVmVyc2lvbkNvbnRyb2wvTGF1bmNoTGF0ZXN0VmVyc2lvbmVkSXRlbS8lMjQlMmZNeUZpcnN0UHJvamVjdCUyZkV4YW1wbGVGb2xkZXIlMmZUZXN0RmlsZTAxLnR4dD9wcm9qZWN0PTg3NDQ2MjJkLTdmMGUtNDZlZi04ZjViLWUxNzk2MjNhNGI1YyZ1cmw9aHR0cHMlM0ElMkYlMkZjb2RlZGV2Lm1zJTJGa2V2aW5tY3B6NDIwJTJG"
  },
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Latest&versionOptions=None",
  "_links": {
    "self": {
      "href": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Changeset&version=10"
    }
  }
}

定義

名前	説明
FileContentMetadata
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
TfvcItem	アイテムのメタデータ。
TfvcVersionOption	既定値は None です。
TfvcVersionType	既定値は [最新] です。
VersionControlRecursionType	既定値は OneLevel です。

FileContentMetadata

名前	型	説明
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

TfvcItem

アイテムのメタデータ。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
changeDate	string	アイテムが datetime に変更されました。
content	string
contentMetadata	FileContentMetadata
deletionId	integer	アイテムが削除された場合は 0 より大きい。
encoding	integer	データベースからのファイルエンコード、-1 はバイナリを表します。
hashValue	string	基本 64 文字列としての MD5 ハッシュは、ファイルにのみ適用されます。
isBranch	boolean	True を指定すると、項目が分岐になります。
isFolder	boolean
isPendingChange	boolean	True の場合は保留中の変更があります。
isSymLink	boolean
path	string
size	integer	該当する場合は、ファイルのサイズ。
url	string
version	integer	Changeset バージョン ID。

TfvcVersionOption

既定値は None です。

名前	型	説明
none	string	[なし] :
previous	string	以前のバージョンを返します。
useRename	string	バージョンタイプ MergeSource と整数バージョンでのみ使用でき、Merge 識別子の代わりに RenameSource 識別子が使用されます。

TfvcVersionType

既定値は [最新] です。

名前	型	説明
change	string	バージョンは変更として扱われます。
changeset	string	バージョンは ChangesetId として扱われます。
date	string	バージョンは日付として扱われます。
latest	string	Version が定義されている場合は、そのバージョンの最新バージョンが使用されます。バージョンが定義されていない場合は、最新の ChangesetId が使用されます。
mergeSource	string	バージョンは MergeSource として扱われます。
none	string	バージョンは ChangesetId として扱われます。
shelveset	string	バージョンは、シェルブセット名と所有者として扱われます。
tip	string	最新のバージョンが定義されていない場合、バージョンはヒントとして扱われます。

VersionControlRecursionType

既定値は OneLevel です。

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

次の方法で共有

Items - Get

URI パラメーター

応答

セキュリティ

oauth2

Scopes

例

GET item metadata and/or content for a single item.

Sample Request

Sample Response

定義

FileContentMetadata

ReferenceLinks

TfvcItem

TfvcVersionOption

TfvcVersionType

VersionControlRecursionType

その他のリソース