Partilhar via

Items - Get

  • Referência
Serviço:
Tfvc
Versão da API:
7.1

Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&api-version=7.1
Com parâmetros opcionais: 
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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.
path
 query True

string

Caminho de controle de versão de um item individual a ser retornado.
download
 query

boolean

Se for true, crie um anexo para download.
fileName
 query

string

nome do arquivo do item retornado.
includeContent
 query

boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
recursionLevel
 query

VersionControlRecursionType

Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
scopePath
 query

string

Caminho de controle de versão de uma pasta para retornar vários itens.
versionDescriptor.version
 query

string

Objeto version.
versionDescriptor.versionOption
 query

TfvcVersionOption

Descritor de versão. O padrão é nulo.
versionDescriptor.versionType
 query

TfvcVersionType

Descritor de versão. O padrão é nulo.

Respostas

Nome Tipo Description
200 OK

TfvcItem

operação bem-sucedida

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

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome Description
vso.code Concede a capacidade de ler o código-fonte e metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
    }
  }
}

Definições

Nome Description
FileContentMetadata
ReferenceLinks

A classe para representar uma coleção de links de referência REST.
TfvcItem

Metadados de um item.
TfvcVersionOption

O padrão é None.
TfvcVersionType

O padrão é o mais recente.
VersionControlRecursionType

O padrão é OneLevel.

FileContentMetadata

Objeto
Nome Tipo Description
contentType

string

encoding

integer (int32)

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

Objeto

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

TfvcItem

Objeto

Metadados de um item.

Nome Tipo Description
_links

ReferenceLinks

A classe para representar uma coleção de links de referência REST.
changeDate

string (date-time)

Data/hora alterada do item.
content

string

contentMetadata

FileContentMetadata

deletionId

integer (int32)

Maior que 0 se o item for excluído.
encoding

integer (int32)

Codificação de arquivo do banco de dados, -1 representa binário.
hashValue

string

O hash MD5 como uma cadeia de caracteres base 64 aplica-se somente a arquivos.
isBranch

boolean

True se o item for um branch.
isFolder

boolean

isPendingChange

boolean

True se houver uma alteração pendente.
isSymLink

boolean

path

string

size

integer (int64)

O tamanho do arquivo, se aplicável.
url

string

version

integer (int32)

ID da versão do conjunto de alterações.

TfvcVersionOption

Enumeração

O padrão é None.

Valor Description
none

Nenhum.
previous

Retorne a versão anterior.
useRename

Somente utilizável com o tipo de versão MergeSource e versões inteiros, usa o identificador RenameSource em vez do identificador merge.

TfvcVersionType

Enumeração

O padrão é o mais recente.

Valor Description
change

A versão é tratada como uma alteração.
changeset

A versão é tratada como um ChangesetId.
date

A versão é tratada como uma Data.
latest

Se a Versão for definida, a versão mais recente dessa versão será usada, se nenhuma versão for definida, o ChangesetId mais recente será usado.
mergeSource

A versão será tratada como MergeSource.
none

A versão é tratada como um ChangesetId.
shelveset

A versão é tratada como um nome e proprietário do Conjunto de Prateleiras.
tip

A versão será tratada como uma Dica, se nenhuma versão for definida mais recente será usada.

VersionControlRecursionType

Enumeração

O padrão é OneLevel.

Valor Description
full

Retornar o item especificado e todos os descendentes
none

Retorne apenas o item especificado.
oneLevel

Retorne o item especificado e seus filhos diretos.
oneLevelPlusNestedEmptyFolders

Retorne o item especificado e seus filhos diretos, bem como cadeias recursivas de pastas filho aninhadas que contêm apenas uma única pasta.