Wikis - Create

リファレンス

Service:: Wiki

API Version:: 5.0

Wiki リソースを作成します。

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis?api-version=5.0

URI パラメーター

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

要求本文

名前	型	説明
mappedPath	string	Wiki として表示されるリポジトリ内のフォルダーパス。 ProjectWiki の種類には必要ありません。
name	string	Wiki 名。
projectId	string	Wiki を作成するプロジェクトの ID。
repositoryId	string	Wiki をバックアップする Git リポジトリの ID。 ProjectWiki の種類には必要ありません。
type	WikiType	Wiki の種類。
version	GitVersionDescriptor	Wiki のバージョン。 ProjectWiki の種類には必要ありません。

応答

名前	型	説明
201 Created	WikiV2	Wiki が作成されました

セキュリティ

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_write	Wiki、Wiki ページ、Wiki 添付ファイルの読み取り、作成、更新を行う機能を付与します。

例

Create code wiki

Create project wiki

Create code wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Sample Response

Status code:: 201

{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Create project wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}

Sample Response

Status code:: 201

{
  "id": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_apis/wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "remoteUrl": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe",
  "repositoryId": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "mappedPath": "/"
}

定義

名前	説明
GitVersionDescriptor
GitVersionOptions	バージョンオプション - バージョンに対して追加の修飾子を指定します (例: Previous)
GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します
WikiCreateParametersV2	Wiki 作成パラメーター。
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	バージョンをタグ名として解釈する

WikiCreateParametersV2

Wiki 作成パラメーター。

名前	型	説明
mappedPath	string	Wiki として表示されるリポジトリ内のフォルダーパス。 ProjectWiki の種類には必要ありません。
name	string	Wiki 名。
projectId	string	Wiki を作成するプロジェクトの ID。
repositoryId	string	Wiki をバックアップする Git リポジトリの ID。 ProjectWiki の種類には必要ありません。
type	WikiType	Wiki の種類。
version	GitVersionDescriptor	Wiki のバージョン。 ProjectWiki の種類には必要ありません。

WikiType

Wiki の種類。

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

WikiV2

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

名前	型	説明
id	string	Wiki の ID。
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 のバージョン。

次の方法で共有

Wikis - Create

URI パラメーター

要求本文

応答

セキュリティ

oauth2

Scopes

例

Create code wiki

Sample Request

Sample Response

Create project wiki

Sample Request

Sample Response

定義

GitVersionDescriptor

GitVersionOptions

GitVersionType

WikiCreateParametersV2

WikiType

WikiV2

その他のリソース