Wikis - Get

Layanan:

Wiki

Versi API:

7.1

Mendapatkan wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
wikiIdentifier	path	True	string	ID Wiki atau nama wiki.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.

Respons

Nama	Jenis	Deskripsi
200 OK	WikiV2	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Cakupan

Nama	Deskripsi
vso.wiki	Memberikan kemampuan untuk membaca wiki, halaman wiki, dan lampiran wiki. Juga memberikan kemampuan untuk mencari halaman wiki.

Contoh

Query by Id

Query by name

Query by Id

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
GitVersionDescriptor
GitVersionOptions	Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)
GitVersionType	Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan
WikiType	Jenis wiki.
WikiV2	Mendefinisikan sumber daya wiki.

GitVersionDescriptor

Objek

Nama	Jenis	Deskripsi
version	string	Pengidentifikasi string versi (nama tag/cabang, SHA1 penerapan)
versionOptions	GitVersionOptions	Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)
versionType	GitVersionType	Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

GitVersionOptions

Enumeration

Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)

Nilai	Deskripsi
firstParent	Induk penerapan pertama (HEAD^)
none	Tidak ditentukan
previousChange	Terapkan item yang diubah sebelum versi saat ini

GitVersionType

Enumeration

Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

Nilai	Deskripsi
branch	Menginterpretasikan versi sebagai nama cabang
commit	Menginterpretasikan versi sebagai ID penerapan (SHA1)
tag	Menginterpretasikan versi sebagai nama tag

WikiType

Enumeration

Jenis wiki.

Nilai	Deskripsi
codeWiki	Menunjukkan bahwa wiki diterbitkan dari repositori git
projectWiki	Menunjukkan bahwa wiki disediakan untuk proyek tim

WikiV2

Objek

Mendefinisikan sumber daya wiki.

Nama	Jenis	Deskripsi
id	string (uuid)	ID wiki.
isDisabled	boolean	Apakah repositori wiki dinonaktifkan
mappedPath	string	Jalur folder di dalam repositori yang ditampilkan sebagai Wiki. Tidak diperlukan untuk jenis ProjectWiki.
name	string	Nama wiki.
projectId	string (uuid)	ID proyek tempat wiki akan dibuat.
properties	object	Properti wiki.
remoteUrl	string	Url web jarak jauh ke wiki.
repositoryId	string (uuid)	ID repositori git yang mencadangkan wiki. Tidak diperlukan untuk jenis ProjectWiki.
type	WikiType	Jenis wiki.
url	string	URL REST untuk wiki ini.
versions	GitVersionDescriptor[]	Versi wiki.