Wikis - Get

Service:

Wiki

API Version:

7.1-preview.2

Ruft das Wiki ab, das der angegebenen Wiki-ID oder dem angegebenen Wikinamen entspricht.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
wikiIdentifier	path	True	string	Wiki-ID oder Wikiname.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	WikiV2	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.wiki	Ermöglicht das Lesen von Wikis, Wiki-Seiten und Wiki-Anlagen. Ermöglicht auch die Suche nach Wikiseiten.

Beispiele

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

Definitionen

Name	Beschreibung
GitVersionDescriptor
GitVersionOptions	Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
GitVersionType	Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.
WikiType	Typ des Wikis.
WikiV2	Definiert eine Wikiressource.

GitVersionDescriptor

Name	Typ	Beschreibung
version	string	Versionszeichenfolgenbezeichner (Name von Tag/Branch, SHA1 des Commits)
versionOptions	GitVersionOptions	Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
versionType	GitVersionType	Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.

GitVersionOptions

Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)

Name	Typ	Beschreibung
firstParent	string	Erstes übergeordnetes Element des Commits (HEAD^)
none	string	Nicht angegeben
previousChange	string	Commit für das geänderte Element vor der aktuellen Version

GitVersionType

Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.

Name	Typ	Beschreibung
branch	string	Interpretieren der Version als Branchname
commit	string	Interpretieren der Version als Commit-ID (SHA1)
tag	string	Interpretieren der Version als Tagname

WikiType

Typ des Wikis.

Name	Typ	Beschreibung
codeWiki	string	Gibt an, dass das Wiki aus einem Git-Repository veröffentlicht wird.
projectWiki	string	Gibt an, dass das Wiki für das Teamprojekt bereitgestellt wird.

WikiV2

Definiert eine Wikiressource.

Name	Typ	Beschreibung
id	string	ID des Wikis.
isDisabled	boolean	Ist das Wiki-Repository deaktiviert?
mappedPath	string	Ordnerpfad innerhalb des Repositorys, das als Wiki angezeigt wird. Für den ProjectWiki-Typ nicht erforderlich.
name	string	Wikiname.
projectId	string	ID des Projekts, in dem das Wiki erstellt werden soll.
properties	object	Eigenschaften des Wikis.
remoteUrl	string	Remoteweb-URL zum Wiki.
repositoryId	string	ID des Git-Repositorys, das das Wiki sichert. Für den ProjectWiki-Typ nicht erforderlich.
type	WikiType	Typ des Wikis.
url	string	REST-URL für dieses Wiki.
versions	GitVersionDescriptor[]	Versionen des Wikis.