Pages - Update

サービス:

Wiki

API バージョン:

7.1

Wiki ページを編集します。

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

省略可能なパラメーターを含む:

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?comment={comment}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
id	path	True	integer (int32)	Wiki ページ ID。
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
wikiIdentifier	path	True	string	Wiki ID または Wiki 名。
api-version	query	True	string	使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
comment	query		string	ページ操作に関連付けるコメント。

要求ヘッダー

名前	必須	型	説明
Version	True	string	変更が行われるページのバージョン。 Edit シナリオでは必須です。 要求の If-Match ヘッダーに設定されます。

要求本文

名前	型	説明
content	string	Wiki ページのコンテンツ。

応答

名前	型	説明
200 OK	WikiPage	ページが編集されました。 編集されたページのバージョンは、ETag 応答ヘッダーに設定されます。 ヘッダー ETag: string

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

名前	説明
vso.wiki_write	Wiki、Wiki ページ、Wiki の添付ファイルの読み取り、作成、更新を行う権限を付与します。

例

Edit a page by Id

要求のサンプル

HTTP

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

{
  "content": "New content for page"
}

応答のサンプル

状態コード:

200

eTag: "c14ea53eb6fc5921c184be18c6b3d2d916548f28"

{
  "path": "/SamplePage973",
  "order": 1,
  "isParentPage": true,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "New content for page"
}

定義

名前	説明
WikiPage	Wiki 内のページを定義します。
WikiPageCreateOrUpdateParameters	ページの作成操作または更新操作のパラメーターをカプセル化するコントラクト。

WikiPage

Object

Wiki 内のページを定義します。

名前	型	説明
content	string	Wiki ページのコンテンツ。
gitItemPath	string	バッキング Git リポジトリに格納されている Wiki ページに対応する Git 項目のパス。
id	integer (int32)	存在する場合、Wiki ページの永続的な識別子
isNonConformant	boolean	True の 場合、ページが準拠していません。つまり、1) 名前がページの名前付け基準と一致しない場合。 2) ページが適切な注文ファイルに有効なエントリを持っていない場合。
isParentPage	boolean	True の 場合、このページのパスの下にサブページがあります。
order	integer (int32)	同じ階層レベルの他のページに対する Wiki ページの順序。
path	string	Wiki ページのパス。
remoteUrl	string	Wiki ページへのリモート Web URL。
subPages	WikiPage[]	現在のページのサブページの一覧。
url	string	この Wiki ページの REST URL。

WikiPageCreateOrUpdateParameters

Object

ページの作成操作または更新操作のパラメーターをカプセル化するコントラクト。

名前	型	説明
content	string	Wiki ページのコンテンツ。