Items - Get

참조

서비스:: Tfvc

API 버전:: 7.1

단일 항목에 대한 항목 메타데이터 및/또는 콘텐츠를 가져옵니다. 다운로드 매개 변수는 콘텐츠를 다운로드로 사용할 수 있는지 아니면 응답에서 스트림으로 전송해야 하는지를 나타내는 것입니다. 항상 다운로드로 반환되는 압축된 콘텐츠에는 적용되지 않습니다.

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

선택적 매개 변수:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.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	버전 개체입니다.
versionDescriptor.versionOption	query		TfvcVersionOption	버전 설명자입니다. 기본값은 null입니다.
versionDescriptor.versionType	query		TfvcVersionType	버전 설명자입니다. 기본값은 null입니다.

응답

Name	형식	Description
200 OK	TfvcItem	성공한 작업 Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Name

형식

Description

200 OK

TfvcItem

성공한 작업

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

보안

oauth2

형식: oauth2
Flow: 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

범위

Name	Description
vso.code	커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 소스 코드 및 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 코드를 검색하고 서비스 후크를 통해 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

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

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 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"
    }
  }
}

정의

Name	Description
FileContentMetadata
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
TfvcItem	항목에 대한 메타데이터입니다.
TfvcVersionOption	기본값은 없음입니다.
TfvcVersionType	기본값은 Latest입니다.
VersionControlRecursionType	기본값은 OneLevel입니다.

FileContentMetadata

Object

Name	형식	Description
contentType	string
encoding	integer (int32)
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Object

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

TfvcItem

Object

항목에 대한 메타데이터입니다.

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
changeDate	string (date-time)	항목이 날짜/시간을 변경했습니다.
content	string
contentMetadata	FileContentMetadata
deletionId	integer (int32)	항목이 삭제된 경우 0보다 큽다.
encoding	integer (int32)	데이터베이스에서 파일 인코딩, -1 이진을 나타냅니다.
hashValue	string	MD5 해시는 기본 64 문자열로 파일에만 적용됩니다.
isBranch	boolean	True이면 항목이 분기입니다.
isFolder	boolean
isPendingChange	boolean	보류 중인 변경 내용이 있는 경우 True입니다.
isSymLink	boolean
path	string
size	integer (int64)	해당하는 경우 파일의 크기입니다.
url	string
version	integer (int32)	변경 집합 버전 ID입니다.

TfvcVersionOption

열거형

기본값은 없음입니다.

값	Description
none	없음.
previous	이전 버전을 반환합니다.
useRename	versiontype MergeSource 및 정수 버전에서만 사용할 수 있으며 병합 식별자 대신 RenameSource 식별자를 사용합니다.

TfvcVersionType

열거형

기본값은 Latest입니다.

값	Description
change	버전은 변경으로 처리됩니다.
changeset	버전은 ChangesetId로 처리됩니다.
date	버전은 날짜로 처리됩니다.
latest	버전이 정의된 경우 해당 버전의 최신 버전이 사용되며, 정의된 버전이 없으면 최신 ChangesetId가 사용됩니다.
mergeSource	버전은 MergeSource로 처리됩니다.
none	버전은 ChangesetId로 처리됩니다.
shelveset	버전은 진열대 이름 및 소유자로 처리됩니다.
tip	최신 버전이 정의되지 않은 경우 버전이 팁으로 처리됩니다.

VersionControlRecursionType

열거형

기본값은 OneLevel입니다.

값	Description
full	지정된 항목 및 모든 하위 항목 반환
none	지정된 항목만 반환합니다.
oneLevel	지정된 항목과 해당 직접 자식을 반환합니다.
oneLevelPlusNestedEmptyFolders	지정된 항목과 해당 직접 자식 및 단일 폴더만 포함하는 중첩된 자식 폴더의 재귀 체인을 반환합니다.

다음을 통해 공유

Items - Get

URI 매개 변수

응답

보안

oauth2

범위

예제

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

샘플 요청

샘플 응답

정의

FileContentMetadata

ReferenceLinks

TfvcItem

TfvcVersionOption

TfvcVersionType

VersionControlRecursionType