Partager via

Pages - Create Or Update

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

Crée ou modifie une page wiki.

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&api-version=7.1
Avec des paramètres facultatifs: 
PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&comment={comment}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&api-version=7.1

Paramètres URI

Nom Dans Obligatoire Type Description
organization
 path True

string

Nom de l’organisation Azure DevOps.
project
 path True

string

ID de projet ou nom du projet
wikiIdentifier
 path True

string

ID wiki ou nom wiki.
api-version
 query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.
path
 query True

string

Chemin d’accès à la page Wiki.
comment
 query

string

Commentaire à associer à l’opération de page.
versionDescriptor.version
 query

string

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

GitVersionOptions

Options de version : spécifier des modificateurs supplémentaires à la version (par exemple Précédent)
versionDescriptor.versionType
 query

GitVersionType

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

En-tête de la demande

Nom Obligatoire Type Description
Version True

string

Version de la page sur laquelle la modification doit être apportée. Obligatoire pour Edit scénario. Pour être renseigné dans l’en-tête If-Match de la requête.

Corps de la demande

Nom Type Description
content

string

Contenu de la page wiki.

Réponses

Nom Type Description
200 OK

WikiPage

Page modifiée. La version de la page modifiée est remplie dans l’en-tête de réponse ETag.

En-têtes

ETag: string
201 Created

WikiPage

Page créée. La version de la page créée est remplie dans l’en-tête de réponse ETag.

En-têtes

ETag: string

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 Accorde la possibilité de lire, de créer et de mettre à jour des wikis, des pages wiki et des pièces jointes wiki.

Exemples

Add a page
Edit a page

Add a page

Exemple de requête

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=SamplePage973&api-version=7.1

{
  "content": "Wiki page content"
}

Exemple de réponse

Code d’état:
201 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
{
  "path": "/SamplePage973",
  "order": 1,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "Wiki page content"
}

Edit a page

Exemple de requête

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/SamplePage973&api-version=7.1

{
  "content": "New content for page"
}

Exemple de réponse

Code d’état:
200 
eTag: "c14ea53eb6fc5921c184be18c6b3d2d916548f28"
{
  "path": "/SamplePage973",
  "order": 1,
  "isParentPage": true,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "New content for page"
}

Définitions

Nom Description
GitVersionOptions

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

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

Définit une page dans un wiki.
WikiPageCreateOrUpdateParameters

Contract encapsulating parameters for the page create or update operations.

GitVersionOptions

Énumération

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

Valeur Description
firstParent

Premier parent de validation (HEAD^)
none

Non spécifié
previousChange

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

GitVersionType

Énumération

Type de version (branche, balise ou validation). 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 en tant que nom de balise

WikiPage

Object

Définit une page dans un wiki.

Nom Type Description
content

string

Contenu de la page wiki.
gitItemPath

string

Chemin d’accès de l’élément Git correspondant à la page wiki stockée dans le référentiel Git de stockage.
id

integer (int32)

Lorsqu’il est présent, identificateur permanent pour la page wiki
isNonConformant

boolean

True si une page n’est pas conforme, c’est-à-dire 1) si le nom ne correspond pas aux normes d’affectation de noms de page. 2) si la page n’a pas d’entrée valide dans le fichier d’ordre approprié.
isParentPage

boolean

True si cette page comporte des sous-pages sous son chemin d’accès.
order

integer (int32)

Ordre de la page wiki, par rapport aux autres pages du même niveau de hiérarchie.
path

string

Chemin d’accès de la page wiki.
remoteUrl

string

URL web distante vers la page wiki.
subPages

WikiPage[]

Liste des sous-pages de la page active.
url

string

URL REST de cette page wiki.

WikiPageCreateOrUpdateParameters

Object

Contract encapsulating parameters for the page create or update operations.

Nom Type Description
content

string

Contenu de la page wiki.