Wikis - Get

Service:

Wiki

API Version:

7.1-preview.2

指定された Wiki ID または Wiki 名に対応する Wiki を取得します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
wikiIdentifier	path	True	string	Wiki ID または Wiki 名。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。

応答

名前	型	説明
200 OK	WikiV2	正常な操作

セキュリティ

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

名前	説明
vso.wiki	Wiki、Wiki ページ、Wiki 添付ファイルを読み取る機能を付与します。 Wiki ページを検索する機能も付与されます。

例

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

定義

名前	説明
GitVersionDescriptor
GitVersionOptions	バージョン オプション - バージョンに追加の修飾子を指定します (例: Previous)
GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します
WikiType	Wiki の種類。
WikiV2	Wiki リソースを定義します。

GitVersionDescriptor

名前	型	説明
version	string	バージョン文字列識別子 (タグ/ブランチの名前、コミットの SHA1)
versionOptions	GitVersionOptions	バージョン オプション - バージョンに追加の修飾子を指定します (例: Previous)
versionType	GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します

GitVersionOptions

バージョン オプション - バージョンに追加の修飾子を指定します (例: Previous)

名前	型	説明
firstParent	string	コミットの最初の親 (HEAD^)
none	string	指定なし
previousChange	string	変更されたアイテムを現在のバージョンより前にコミットする

GitVersionType

バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します

名前	型	説明
branch	string	バージョンをブランチ名として解釈する
commit	string	バージョンをコミット ID (SHA1) として解釈する
tag	string	バージョンをタグ名として解釈する

WikiType

Wiki の種類。

名前	型	説明
codeWiki	string	Wiki が Git リポジトリから発行されていることを示します
projectWiki	string	Wiki がチーム プロジェクト用にプロビジョニングされていることを示します

WikiV2

Wiki リソースを定義します。

名前	型	説明
id	string	Wiki の ID。
isDisabled	boolean	Wiki リポジトリが無効になっているか
mappedPath	string	Wiki として表示されるリポジトリ内のフォルダー パス。 ProjectWiki 型には必要ありません。
name	string	Wiki 名。
projectId	string	Wiki を作成するプロジェクトの ID。
properties	object	Wiki のプロパティ。
remoteUrl	string	Wiki へのリモート Web URL。
repositoryId	string	Wiki をバックアップする Git リポジトリの ID。 ProjectWiki 型には必要ありません。
type	WikiType	Wiki の種類。
url	string	この Wiki の REST URL。
versions	GitVersionDescriptor[]	Wiki のバージョン。