Wikis - Get

Service:

Wiki

API Version:

7.1-preview.2

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-preview.2

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El 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-preview.2" para usar esta versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	WikiV2	operación correcta

Seguridad

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: 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

Scopes

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

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

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

Nombre	Tipo	Description
firstParent	string	Primer elemento primario de confirmación (HEAD^)
none	string	Sin especificar
previousChange	string	Confirmar que cambió el elemento antes de la versión actual

GitVersionType

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

Nombre	Tipo	Description
branch	string	Interpretar la versión como un nombre de rama
commit	string	Interpretar la versión como un identificador de confirmación (SHA1)
tag	string	Interpretar la versión como un nombre de etiqueta

WikiType

Tipo de wiki.

Nombre	Tipo	Description
codeWiki	string	Indica que la wiki se publica desde un repositorio git.
projectWiki	string	Indica que la wiki se aprovisiona para el proyecto de equipo.

WikiV2

Define un recurso wiki.

Nombre	Tipo	Description
id	string	Identificador 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	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	Identificador del repositorio 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.