Sdílet prostřednictvím

Wikis - Get

  • Reference
Služba:
Wiki
Verze rozhraní API:
7.1

Získá wikiweb odpovídající ID wikiwebu nebo zadaný název wikiwebu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
organization
 path True

string

Název organizace Azure DevOps.
wikiIdentifier
 path True

string

ID wikiwebu nebo název wikiwebu
project
 path

string

ID projektu nebo název projektu
api-version
 query True

string

Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Odpovědi

Name Typ Description
200 OK

WikiV2

úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name Description
vso.wiki Uděluje možnost číst wikiweby, stránky wikiwebu a přílohy wikiwebu. Umožňuje také prohledávat stránky wikiwebu.

Příklady

Query by Id
Query by name

Query by Id

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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": "/"
}

Definice

Name Description
GitVersionDescriptor
GitVersionOptions

Možnosti verze – Určení dalších modifikátorů pro verzi (např. Předchozí)
GitVersionType

Typ verze (větev, značka nebo potvrzení) Určuje způsob interpretace ID.
WikiType

Typ wikiwebu
WikiV2

Definuje prostředek wikiwebu.

GitVersionDescriptor

Objekt
Name Typ Description
version

string

Identifikátor řetězce verze (název značky/větve, SHA1 potvrzení)
versionOptions

GitVersionOptions

Možnosti verze – Určení dalších modifikátorů pro verzi (např. Předchozí)
versionType

GitVersionType

Typ verze (větev, značka nebo potvrzení) Určuje způsob interpretace ID.

GitVersionOptions

Výčet

Možnosti verze – Určení dalších modifikátorů pro verzi (např. Předchozí)

Hodnota Description
firstParent

První nadřazený prvek potvrzení (HEAD^)
none

Nezadá se
previousChange

Potvrzení změny položky před aktuální verzí

GitVersionType

Výčet

Typ verze (větev, značka nebo potvrzení) Určuje způsob interpretace ID.

Hodnota Description
branch

Interpretace verze jako názvu větve
commit

Interpretace verze jako ID potvrzení (SHA1)
tag

Interpretace verze jako názvu značky

WikiType

Výčet

Typ wikiwebu

Hodnota Description
codeWiki

Označuje, že wikiweb je publikovaný z úložiště Git.
projectWiki

Označuje, že wikiweb je zřízený pro týmový projekt.

WikiV2

Objekt

Definuje prostředek wikiwebu.

Name Typ Description
id

string (uuid)

ID wikiwebu.
isDisabled

boolean

Je zakázané úložiště wikiwebu.
mappedPath

string

Cesta ke složce uvnitř úložiště, která se zobrazuje jako wikiweb. Není vyžadováno pro typ ProjectWiki.
name

string

Název wikiwebu
projectId

string (uuid)

ID projektu, ve kterém se má wikiweb vytvořit.
properties

object

Vlastnosti wikiwebu
remoteUrl

string

Vzdálená webová adresa URL wikiwebu
repositoryId

string (uuid)

ID úložiště Git, které zálohuje wikiweb. Není vyžadováno pro typ ProjectWiki.
type

WikiType

Typ wikiwebu
url

string

Adresa URL REST pro tento wikiweb
versions

GitVersionDescriptor[]

Verze wikiwebu