Partager via

Wikis - Create

  • Référence
Service:
Wiki
Version d'API:
5.0

Crée la ressource wiki.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
 path True

string

Nom de l’organisation Azure DevOps.
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 « 5.0 » pour utiliser cette version de l’API.

Corps de la demande

Nom Type Description
mappedPath

string

Chemin du dossier à l’intérieur du référentiel qui est affiché sous la forme Wiki. Non obligatoire pour le type ProjectWiki.
name

string

Nom du wiki.
projectId

string

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

string

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

WikiType

Type du wiki.
version

GitVersionDescriptor

Version du wiki. Non obligatoire pour le type ProjectWiki.

Réponses

Nom Type Description
201 Created

WikiV2

Wiki créé

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.wiki_write Permet de lire, de créer et de mettre à jour des wikis, des pages wiki et des pièces jointes wiki.

Exemples

Create code wiki
Create project wiki

Create code wiki

Exemple de requête

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Exemple de réponse

Code d’état:
201 
{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Create project wiki

Exemple de requête

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}

Exemple de réponse

Code d’état:
201 
{
  "id": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_apis/wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "remoteUrl": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe",
  "repositoryId": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "mappedPath": "/"
}

Définitions

Nom Description
GitVersionDescriptor
GitVersionOptions

Options de version : spécifier des modificateurs supplémentaires à la version (par exemple, précédent)
GitVersionType

Type de version (branche, balise ou commit). Détermine la façon dont l’ID est interprété
WikiCreateParametersV2

Paramètres de création wiki.
WikiType

Type du wiki.
WikiV2

Définit une ressource wiki.

GitVersionDescriptor

Object
Nom Type Description
version

string

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

GitVersionOptions

Options de version : spécifier des modificateurs supplémentaires à la version (par exemple, précédent)
versionType

GitVersionType

Type de version (branche, balise ou commit). Détermine la façon dont l’ID est interprété

GitVersionOptions

Enumeration

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

Valeur Description
firstParent

Premier parent de commit (HEAD^)
none

Non spécifié
previousChange

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

GitVersionType

Enumeration

Type de version (branche, balise ou commit). Détermine la façon dont l’ID est interprété

Valeur Description
branch

Interpréter la version en tant que nom de branche
commit

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

Interpréter la version comme un nom de balise

WikiCreateParametersV2

Object

Paramètres de création wiki.

Nom Type Description
mappedPath

string

Chemin du dossier à l’intérieur du référentiel qui est affiché sous la forme Wiki. Non obligatoire pour le type ProjectWiki.
name

string

Nom du wiki.
projectId

string

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

string

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

WikiType

Type du wiki.
version

GitVersionDescriptor

Version du wiki. Non obligatoire pour le type ProjectWiki.

WikiType

Enumeration

Type du wiki.

Valeur Description
codeWiki

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

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

WikiV2

Object

Définit une ressource wiki.

Nom Type Description
id

string

ID du wiki.
mappedPath

string

Chemin du dossier à l’intérieur du référentiel qui est affiché sous la forme 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.