Compartir a través de

Wikis - Get

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

Obtiene la wiki correspondiente al identificador de wiki o al nombre de wiki proporcionado.

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?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.
wikiIdentifier
 path True

string

Id. de wiki o nombre de wiki.
project
 path

string

Id. de proyecto o nombre del proyecto
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.

Respuestas

Nombre Tipo Description
200 OK

WikiV2

operación correcta

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 Concede la capacidad de leer wikis, páginas wiki y datos adjuntos wiki. También concede la capacidad de buscar páginas wiki.

Ejemplos

Query by Id
Query by name

Query by Id

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
GitVersionDescriptor
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.
WikiType

Tipo de wiki.
WikiV2

Define un recurso wiki.

GitVersionDescriptor

Object
Nombre Tipo Description
version

string

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

GitVersionOptions

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

GitVersionType

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

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

WikiType

Enumeración

Tipo de wiki.

Valor Description
codeWiki

Indica que la wiki se publica desde un repositorio git.
projectWiki

Indica que la wiki está aprovisionada para el proyecto de equipo.

WikiV2

Object

Define un recurso wiki.

Nombre Tipo Description
id

string (uuid)

Id. de la wiki.
isDisabled

boolean

¿Está deshabilitado el repositorio wiki?
mappedPath

string

Ruta de acceso de carpeta dentro del repositorio que se muestra como Wiki. No es necesario para el tipo ProjectWiki.
name

string

Nombre de wiki.
projectId

string (uuid)

Identificador del proyecto en el que se va a crear la wiki.
properties

object

Propiedades de la wiki.
remoteUrl

string

Dirección URL web remota a la wiki.
repositoryId

string (uuid)

Identificador del repositorio de Git que realiza una copia de seguridad de la wiki. No es necesario para el tipo ProjectWiki.
type

WikiType

Tipo de wiki.
url

string

Dirección URL de REST para esta wiki.
versions

GitVersionDescriptor[]

Versiones de la wiki.