Wikis - Get

Service:

Wiki

API Version:

6.0

Obtém o wiki correspondente à ID wiki ou ao nome wiki fornecido.

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?api-version=6.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
wikiIdentifier	path	True	string	ID do Wiki ou nome wiki.
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 '6.0' para usar essa versão da api.

Respostas

Nome	Tipo	Description
200 OK	WikiV2	operação bem-sucedida

Segurança

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

Nome	Description
vso.wiki	Concede a capacidade de ler wikis, páginas wiki e anexos wiki. Também concede a capacidade de pesquisar páginas wiki.

Exemplos

Query by Id

Query by name

Query by Id

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wiki/wikis/{wikiIdentifier}?api-version=6.0

Sample Response

Status code:

200

{
  "id": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "mappedPath": "/"
}

Query by name

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wiki/wikis/{wikiIdentifier}?api-version=6.0

Sample Response

Status code:

200

{
  "id": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
  "mappedPath": "/"
}

Definições

Nome	Description
GitVersionDescriptor
GitVersionOptions	Opções de versão – especificar modificadores adicionais para a versão (por exemplo, Anterior)
GitVersionType	Tipo de versão (branch, marca ou commit). Determina como a ID é interpretada
WikiType	Tipo do wiki.
WikiV2	Define um recurso wiki.

GitVersionDescriptor

Nome	Tipo	Description
version	string	Identificador de cadeia de caracteres de versão (nome da marca/branch, SHA1 de commit)
versionOptions	GitVersionOptions	Opções de versão – especificar modificadores adicionais para a versão (por exemplo, Anterior)
versionType	GitVersionType	Tipo de versão (branch, marca ou commit). Determina como a ID é interpretada

GitVersionOptions

Opções de versão – especificar modificadores adicionais para a versão (por exemplo, Anterior)

Nome	Tipo	Description
firstParent	string	Primeiro pai do commit (HEAD^)
none	string	Não especificado
previousChange	string	Confirmar esse item alterado antes da versão atual

GitVersionType

Tipo de versão (branch, marca ou commit). Determina como a ID é interpretada

Nome	Tipo	Description
branch	string	Interpretar a versão como um nome de branch
commit	string	Interpretar a versão como um ID do commit (SHA1)
tag	string	Interpretar a versão como um nome de marca

WikiType

Tipo do wiki.

Nome	Tipo	Description
codeWiki	string	Indica que o wiki foi publicado de um repositório git
projectWiki	string	Indica que o wiki está provisionado para o projeto de equipe

WikiV2

Define um recurso wiki.

Nome	Tipo	Description
id	string	ID do wiki.
mappedPath	string	Caminho da pasta dentro do repositório, que é mostrado como Wiki. Não é necessário para o tipo ProjectWiki.
name	string	Nome do wiki.
projectId	string	ID do projeto no qual o wiki deve ser criado.
properties	object	Propriedades do wiki.
remoteUrl	string	URL da Web remota para o wiki.
repositoryId	string	ID do repositório git que faz backup do wiki. Não é necessário para o tipo ProjectWiki.
type	WikiType	Tipo do wiki.
url	string	URL REST para este wiki.
versions	GitVersionDescriptor[]	Versões do wiki.