Pages - Update

Servicio:

Wiki

Versión de la API:

7.1

Edita una página wiki.

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?api-version=7.1

Con parámetros opcionales:

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?comment={comment}&api-version=7.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	integer (int32)	Id. de página wiki.
organization	path	True	string	Nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
wikiIdentifier	path	True	string	Id. de wiki o nombre de wiki.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.
comment	query		string	Comentario que se va a asociar a la operación de página.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Version	True	string	Versión de la página en la que se va a realizar el cambio. Obligatorio para Edit escenario. Para rellenarse en el encabezado If-Match de la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
content	string	Contenido de la página wiki.

Respuestas

Nombre	Tipo	Description
200 OK	WikiPage	Página editada. La versión de la página editada se rellena en el encabezado de respuesta ETag. Encabezados ETag: string

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.wiki_write	Concede la capacidad de leer, crear y actualizar wikis, páginas wiki y datos adjuntos wiki.

Ejemplos

Edit a page by Id

Solicitud de ejemplo

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?api-version=7.1

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
WikiPage	Define una página en una wiki.
WikiPageCreateOrUpdateParameters	Encapsular parámetros para las operaciones de creación o actualización de páginas.

WikiPage

Object

Define una página en una wiki.

Nombre	Tipo	Description
content	string	Contenido de la página wiki.
gitItemPath	string	Ruta de acceso del elemento git correspondiente a la página wiki almacenada en el repositorio de Git de respaldo.
id	integer (int32)	Cuando está presente, identificador permanente para la página wiki
isNonConformant	boolean	True si una página no cumple los requisitos, es decir, 1) si el nombre no coincide con los estándares de nomenclatura de páginas. 2) si la página no tiene una entrada válida en el archivo de orden adecuado.
isParentPage	boolean	True si esta página tiene subpáginas en su ruta de acceso.
order	integer (int32)	Orden de la página wiki, en relación con otras páginas en el mismo nivel de jerarquía.
path	string	Ruta de acceso de la página wiki.
remoteUrl	string	Dirección URL web remota a la página wiki.
subPages	WikiPage[]	Lista de subpáginas de la página actual.
url	string	Dirección URL de REST para esta página wiki.

WikiPageCreateOrUpdateParameters

Object

Encapsular parámetros para las operaciones de creación o actualización de páginas.

Nombre	Tipo	Description
content	string	Contenido de la página wiki.