Items - Get

Service:

Git

API Version:

7.1-preview.1

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

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
repositoryId	path	True	string	리포지토리의 이름 또는 ID입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다.
path	query	True	string	항목 경로입니다.
$format	query		string	지정된 경우 HTTP 수락 요청 헤더를 재정의하여 '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'이고 재귀는 없습니다.
resolveLfs	query		boolean	Git LFS 실제 콘텐츠를 반환하도록 Git LFS 포인터 파일을 resolve true로 설정합니다. 기본값은 false입니다.
sanitize	query		boolean	svg 파일을 삭제하고 이미지로 반환하려면 true로 설정합니다. svg 파일에 대해 요청된 경우에만 유용합니다. 기본값은 false입니다.
scopePath	query		string	경로 scope. 기본값은 null입니다.
versionDescriptor.version	query		string	버전 문자열 식별자(태그/분기 이름, 커밋의 SHA1)
versionDescriptor.versionOptions	query		GitVersionOptions	버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전)
versionDescriptor.versionType	query		GitVersionType	버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다.

응답

Name	형식	Description
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

Name	Description
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"
    }
  ]
}

정의

Name	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Git 커밋 및 연결된 메타데이터를 설명하는 속성을 제공합니다.
GitItem
GitObjectType	개체 유형(Commit, Tree, Blob, Tag)
GitPushRef
GitStatus	이 클래스에는 상태 게시하는 서비스/확장의 메타데이터가 포함됩니다.
GitStatusContext	상태 고유하게 식별하는 상태 컨텍스트입니다.
GitStatusState	상태 상태입니다.
GitTemplate
GitUserDate	Git 작업의 사용자 정보 및 날짜입니다.
GitVersionOptions	버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전)
GitVersionType	버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
ResourceRef
VersionControlChangeType	항목에 적용된 변경 유형입니다.
VersionControlRecursionType	자식(OneLevel), 모든 하위 항목(전체) 또는 없음을 포함할지 여부를 지정합니다.

ChangeCountDictionary

FileContentMetadata

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

GitChange

Name	형식	Description
changeId	integer	변경 내용 그룹 내의 변경 내용 ID입니다.
changeType	VersionControlChangeType	항목에 적용된 변경 유형입니다.
item	string	현재 버전입니다.
newContent	ItemContent	변경 후 항목의 콘텐츠입니다.
newContentTemplate	GitTemplate	새 변경 내용을 푸시할 때 사용할 새 콘텐츠 템플릿입니다.
originalPath	string	현재 경로와 다른 경우 항목의 원래 경로입니다.
sourceServerItem	string	서버에서 항목의 경로입니다.
url	string	항목을 검색할 URL입니다.

GitCommitRef

Git 커밋 및 연결된 메타데이터를 설명하는 속성을 제공합니다.

Name	형식	Description
_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

Name	형식	Description
_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)

Name	형식	Description
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

이 클래스에는 상태 게시하는 서비스/확장의 메타데이터가 포함됩니다.

Name	형식	Description
_links	ReferenceLinks	참조 링크입니다.
context	GitStatusContext	상태 컨텍스트입니다.
createdBy	IdentityRef	상태 만든 ID입니다.
creationDate	string	상태 생성 날짜 및 시간입니다.
description	string	상태 설명입니다. 일반적으로 상태 현재 상태를 설명합니다.
id	integer	상태 식별자입니다.
state	GitStatusState	상태 상태입니다.
targetUrl	string	상태 세부 정보가 있는 URL입니다.
updatedDate	string	상태 마지막 업데이트 날짜 및 시간입니다.

GitStatusContext

상태 고유하게 식별하는 상태 컨텍스트입니다.

Name	형식	Description
genre	string	상태 장르. 일반적으로 상태 생성하는 서비스/도구의 이름은 비어 있을 수 있습니다.
name	string	상태 이름 식별자는 null이거나 비워 둘 수 없습니다.

GitStatusState

상태 상태입니다.

Name	형식	Description
error	string	오류가 있는 상태입니다.
failed	string	상태가 실패했습니다.
notApplicable	string	상태는 대상 개체에 적용되지 않습니다.
notSet	string	상태 상태가 설정되지 않았습니다. 기본 상태입니다.
pending	string	보류 중인 상태입니다.
succeeded	string	상태가 성공했습니다.

GitTemplate

Name	형식	Description
name	string	템플릿의 이름
type	string	템플릿 유형

GitUserDate

Git 작업의 사용자 정보 및 날짜입니다.

Name	형식	Description
date	string	Git 작업의 날짜입니다.
email	string	Git 작업을 수행하는 사용자의 주소를 Email.
imageUrl	string	사용자의 아바타에 대한 URL입니다.
name	string	Git 작업을 수행하는 사용자의 이름입니다.

GitVersionOptions

버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전)

Name	형식	Description
firstParent	string	커밋의 첫 번째 부모(HEAD^)
none	string	지정되지 않음
previousChange	string	현재 버전 이전에 변경된 항목을 커밋합니다.

GitVersionType

버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다.

Name	형식	Description
branch	string	버전을 분기 이름으로 해석
commit	string	버전을 SHA1(커밋 ID)으로 해석
tag	string	버전을 태그 이름으로 해석

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string	사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string	사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.
inactive	boolean	사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다.
isAadIdentity	boolean	사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다.
isContainer	boolean	사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	사용되지 않음 - ToIdentityRef의 대부분의 기존 구현에서 사용되지 않음
uniqueName	string	사용되지 않음 - 대신 Domain+PrincipalName 사용
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

ItemContent

Name	형식	Description
content	string
contentType	ItemContentType

ItemContentType

Name	형식	Description
base64Encoded	string
rawText	string

ReferenceLinks

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

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

ResourceRef

Name	형식	Description
id	string
url	string

VersionControlChangeType

항목에 적용된 변경 유형입니다.

Name	형식	Description
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), 모든 하위 항목(전체) 또는 없음을 포함할지 여부를 지정합니다.

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