Compartir a través de

Page Moves - Create

  • Referencia
Servicio:
Wiki
Versión de la API:
7.1

Crea una operación de movimiento de página que actualiza la ruta de acceso y el orden de la página tal como se proporciona en los parámetros.

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagemoves?api-version=7.1
Con parámetros opcionales: 
POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagemoves?comment={comment}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&api-version=7.1

Parámetros de identificador URI

Nombre En Requerido Tipo Description
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 este movimiento de página.
versionDescriptor.version
 query

string

Identificador de cadena de versión (nombre de etiqueta/rama, SHA1 de confirmación)
versionDescriptor.versionOptions
 query

GitVersionOptions

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, anterior)
versionDescriptor.versionType
 query

GitVersionType

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

Cuerpo de la solicitud

Nombre Tipo Description
newOrder

integer (int32)

Nuevo orden de la página wiki.
newPath

string

Nueva ruta de acceso de la página wiki.
path

string

Ruta de acceso actual de la página wiki.

Respuestas

Nombre Tipo Description
201 Created

WikiPageMove

Movimiento de página creado. La versión de la página movida 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

Reorder page
Reparent page

Reorder page

Solicitud de ejemplo

POST https://dev.azure.com/fabrikam/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagemoves?api-version=7.1

{
  "path": "SamplePage730",
  "newPath": "SamplePage730",
  "newOrder": 0
}

Respuesta de muestra

status code:
201 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
{
  "page": {
    "path": "/SamplePage730",
    "order": 0,
    "gitItemPath": "/SamplePage730.md",
    "subPages": [],
    "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05/pages/SamplePage730",
    "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05?pagePath=%2FSamplePage730",
    "content": ""
  },
  "path": "SamplePage730",
  "newPath": "SamplePage730",
  "newOrder": 0
}

Reparent page

Solicitud de ejemplo

POST https://dev.azure.com/fabrikam/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagemoves?api-version=7.1

{
  "path": "SamplePage417",
  "newPath": "SamplePage418/SamplePage417",
  "newOrder": 0
}

Respuesta de muestra

status code:
201 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
{
  "page": {
    "path": "/SamplePage418/SamplePage417",
    "order": 0,
    "gitItemPath": "/SamplePage418/SamplePage417.md",
    "subPages": [],
    "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05/pages/SamplePage418%2FSamplePage417",
    "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05?pagePath=%2FSamplePage418%2FSamplePage417",
    "content": ""
  },
  "path": "SamplePage417",
  "newPath": "SamplePage418/SamplePage417",
  "newOrder": 0
}

Definiciones

Nombre Description
GitVersionOptions

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, anterior)
GitVersionType

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.
WikiPage

Define una página en una wiki.
WikiPageMove

Solicitar contrato para movimiento de página wiki.
WikiPageMoveParameters

Encapsular parámetros para la operación de movimiento de página.

GitVersionOptions

Enumeración

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, anterior)

Valor Description
firstParent

Primer elemento primario de confirmación (HEAD^)
none

No especificado
previousChange

Confirmar que ha cambiado el elemento antes de la versión actual

GitVersionType

Enumeración

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

Valor Description
branch

Interpretación de la versión como un nombre de rama
commit

Interpretar la versión como un identificador de confirmación (SHA1)
tag

Interpretación de la versión como un nombre de etiqueta

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.

WikiPageMove

Object

Solicitar contrato para movimiento de página wiki.

Nombre Tipo Description
newOrder

integer (int32)

Nuevo orden de la página wiki.
newPath

string

Nueva ruta de acceso de la página wiki.
page

WikiPage

Página resultante de esta operación de movimiento de página.
path

string

Ruta de acceso actual de la página wiki.

WikiPageMoveParameters

Object

Encapsular parámetros para la operación de movimiento de página.

Nombre Tipo Description
newOrder

integer (int32)

Nuevo orden de la página wiki.
newPath

string

Nueva ruta de acceso de la página wiki.
path

string

Ruta de acceso actual de la página wiki.