Partager via


Wikis - Get

Obtient le wiki correspondant à l’ID wiki ou au nom de wiki fourni.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

wikiIdentifier
path True

string

ID du wiki ou nom du wiki.

project
path

string

ID de projet ou nom du projet

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.2 » pour utiliser cette version de l’API.

Réponses

Nom Type Description
200 OK

WikiV2

opération réussie

Sécurité

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

Nom Description
vso.wiki Permet de lire des wikis, des pages wiki et des pièces jointes wiki. Accorde également la possibilité de rechercher des pages wiki.

Exemples

Query by Id
Query by name

Query by Id

Sample Request

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

Sample Response

{
  "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

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

Sample Response

{
  "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": "/"
}

Définitions

Nom Description
GitVersionDescriptor
GitVersionOptions

Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)

GitVersionType

Type de version (branche, balise ou commit). Détermine comment l’ID est interprété

WikiType

Type du wiki.

WikiV2

Définit une ressource wiki.

GitVersionDescriptor

Nom Type Description
version

string

Identificateur de chaîne de version (nom de la balise/branche, SHA1 de la validation)

versionOptions

GitVersionOptions

Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)

versionType

GitVersionType

Type de version (branche, balise ou commit). Détermine comment l’ID est interprété

GitVersionOptions

Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)

Nom Type Description
firstParent

string

Premier parent de commit (HEAD^)

none

string

Non spécifié

previousChange

string

Valider l’élément modifié avant la version actuelle

GitVersionType

Type de version (branche, balise ou commit). Détermine comment l’ID est interprété

Nom Type Description
branch

string

Interpréter la version en tant que nom de branche

commit

string

Interpréter la version en tant qu’ID de validation (SHA1)

tag

string

Interpréter la version comme un nom de balise

WikiType

Type du wiki.

Nom Type Description
codeWiki

string

Indique que le wiki est publié à partir d’un dépôt Git

projectWiki

string

Indique que le wiki est provisionné pour le projet d’équipe

WikiV2

Définit une ressource wiki.

Nom Type Description
id

string

ID du wiki.

isDisabled

boolean

Le dépôt wiki est-il désactivé ?

mappedPath

string

Chemin d’accès au dossier à l’intérieur du référentiel, qui est affiché en tant que Wiki. Non obligatoire pour le type ProjectWiki.

name

string

Nom du wiki.

projectId

string

ID du projet dans lequel le wiki doit être créé.

properties

object

Propriétés du wiki.

remoteUrl

string

URL web distante vers le wiki.

repositoryId

string

ID du dépôt Git qui sauvegarde le wiki. Non obligatoire pour le type ProjectWiki.

type

WikiType

Type du wiki.

url

string

URL REST pour ce wiki.

versions

GitVersionDescriptor[]

Versions du wiki.