Wikis - Get

Service:

Wiki

API Version:

5.0

Ottiene il wiki corrispondente al nome wiki o all'ID specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
wikiIdentifier	path	True	string	Nome wiki o ID.
project	path		string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '5.0' per usare questa versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	WikiV2	operazione riuscita

Sicurezza

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	Descrizione
vso.wiki	Concede la possibilità di leggere wiki, pagine wiki e allegati wiki. Concede anche la possibilità di cercare pagine wiki.

Esempio

Query by Id

Query by name

Query by Id

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wiki/wikis/{wikiIdentifier}?api-version=5.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=5.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": "/"
}

Definizioni

Nome	Descrizione
GitVersionDescriptor
GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID
WikiType	Tipo di wiki.
WikiV2	Definisce una risorsa wiki.

GitVersionDescriptor

Nome	Tipo	Descrizione
version	string	Identificatore stringa di versione (nome del tag/ramo, SHA1 del commit)
versionOptions	GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
versionType	GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

GitVersionOptions

Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)

Nome	Tipo	Descrizione
firstParent	string	Primo padre del commit (HEAD^)
none	string	Non specificato
previousChange	string	Eseguire il commit dell'elemento modificato prima della versione corrente

GitVersionType

Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

Nome	Tipo	Descrizione
branch	string	Interpretare la versione come nome di ramo
commit	string	Interpretare la versione come ID commit (SHA1)
tag	string	Interpretare la versione come nome di tag

WikiType

Tipo di wiki.

Nome	Tipo	Descrizione
codeWiki	string	Indica che il wiki viene pubblicato da un repository Git
projectWiki	string	Indica che il wiki viene effettuato il provisioning per il progetto team

WikiV2

Definisce una risorsa wiki.

Nome	Tipo	Descrizione
id	string	ID del wiki.
mappedPath	string	Percorso della cartella all'interno del repository visualizzato come Wiki. Non obbligatorio per il tipo ProjectWiki.
name	string	Nome wiki.
projectId	string	ID del progetto in cui deve essere creato il wiki.
properties	object	Proprietà del wiki.
remoteUrl	string	Url Web remoto al wiki.
repositoryId	string	ID del repository git che esegue il backup del wiki. Non obbligatorio per il tipo ProjectWiki.
type	WikiType	Tipo di wiki.
url	string	URL REST per questo wiki.
versions	GitVersionDescriptor[]	Versioni del wiki.