Pages Batch - Get

リファレンス

サービス:: Wiki

API バージョン:: 7.1

Wiki ページのページング可能なリストを返します

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

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

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagesbatch?versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
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' に設定する必要があります。
versionDescriptor.version	query		string	バージョン文字列識別子 (タグ/ブランチの名前、コミットの SHA1)
versionDescriptor.versionOptions	query		GitVersionOptions	バージョンオプション - バージョンに対して追加の修飾子を指定する (例: Previous)
versionDescriptor.versionType	query		GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します

要求本文

名前	型	説明
continuationToken	string	返されるページデータの一覧が完全でない場合は、ページの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 Wiki ページデータの最初のバッチを取得するには、このパラメーターを省略します。
pageViewsForDays	integer (int32)	ページビューが返される現在の日の最後の N 日。現在の日を含みます。
top	integer (int32)	返される Wiki のページの合計数。

応答

名前	型	説明
200 OK	WikiPageDetail[]	成功した操作

セキュリティ

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	Wiki、Wiki ページ、Wiki の添付ファイルを読み取る権限を付与します。 Wiki ページを検索する機能も付与されます。

例

Get page details in batch after sending continuation token

Get page details in batch with page views

Get page details in batch without sending continuation token

Get page details in batch after sending continuation token

要求のサンプル

HTTP

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

{
  "continuationToken": "78",
  "top": 5
}

応答のサンプル

状態コード:: 200

x-MS-ContinuationToken: 82

{
  "count": 4,
  "value": [
    {
      "path": "/TestPage936",
      "id": 79
    },
    {
      "path": "/TestPage293",
      "id": 80
    },
    {
      "path": "/TestPage842",
      "id": 81
    },
    {
      "path": "/TestPage362",
      "id": 82
    }
  ]
}

Get page details in batch with page views

要求のサンプル

HTTP

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

{
  "pageViewsForDays": 30,
  "continuationToken": "1",
  "top": 5
}

応答のサンプル

状態コード:: 200

x-MS-ContinuationToken: 6

{
  "count": 5,
  "value": [
    {
      "path": "/Test Sample page",
      "id": 2,
      "viewStats": [
        {
          "day": "2019-10-15T00:00:00",
          "count": 2
        }
      ]
    },
    {
      "path": "/TestPage364",
      "id": 3,
      "viewStats": [
        {
          "day": "2019-10-15T00:00:00",
          "count": 1
        }
      ]
    },
    {
      "path": "/TestPage235",
      "id": 4,
      "viewStats": [
        {
          "day": "2019-10-15T00:00:00",
          "count": 3
        }
      ]
    },
    {
      "path": "/TestPage767",
      "id": 5,
      "viewStats": [
        {
          "day": "2019-10-15T00:00:00",
          "count": 5
        },
        {
          "day": "2019-10-16T00:00:00",
          "count": 2
        },
        {
          "day": "2019-10-17T00:00:00",
          "count": 1
        }
      ]
    },
    {
      "path": "/TestPage287",
      "id": 6,
      "viewStats": [
        {
          "day": "2019-10-15T00:00:00",
          "count": 1
        }
      ]
    }
  ]
}

Get page details in batch without sending continuation token

要求のサンプル

HTTP

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

{
  "top": 5
}

応答のサンプル

状態コード:: 200

x-MS-ContinuationToken: 5

{
  "count": 5,
  "value": [
    {
      "path": "/Test Page",
      "id": 1
    },
    {
      "path": "/Test Sample page",
      "id": 2
    },
    {
      "path": "/TestPage364",
      "id": 3
    },
    {
      "path": "/TestPage235",
      "id": 4
    },
    {
      "path": "/TestPage767",
      "id": 5
    }
  ]
}

定義

名前	説明
GitVersionOptions	バージョンオプション - バージョンに対して追加の修飾子を指定する (例: Previous)
GitVersionType	バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します
WikiPageDetail	Wiki で、そのメテディアタを含むページを定義します。
WikiPagesBatchRequest	ページバッチのパラメーターをカプセル化するコントラクト。
WikiPageStat	Wiki ページ統計のプロパティを定義します。

GitVersionOptions

列挙

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

値	説明
firstParent	コミットの最初の親 (HEAD^)
none	指定されていません
previousChange	現在のバージョンより前の変更された項目をコミットする

GitVersionType

列挙

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

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

WikiPageDetail

Object

Wiki で、そのメテディアタを含むページを定義します。

名前	型	説明
id	integer (int32)	存在する場合、Wiki ページの永続的な識別子
path	string	Wiki ページのパス。
viewStats	WikiPageStat[]	Wiki ページのパス。

WikiPagesBatchRequest

Object

ページバッチのパラメーターをカプセル化するコントラクト。

名前	型	説明
continuationToken	string	返されるページデータの一覧が完全でない場合は、ページの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 Wiki ページデータの最初のバッチを取得するには、このパラメーターを省略します。
pageViewsForDays	integer (int32)	ページビューが返される現在の日の最後の N 日。現在の日を含みます。
top	integer (int32)	返される Wiki のページの合計数。

WikiPageStat

Object

Wiki ページ統計のプロパティを定義します。

名前	型	説明
count	integer (int32)	日の統計の数
day	string (date-time)	統計の日

次の方法で共有

Pages Batch - Get

URI パラメーター

要求本文

応答

セキュリティ

oauth2

スコープ

例

Get page details in batch after sending continuation token

要求のサンプル

応答のサンプル

Get page details in batch with page views

要求のサンプル

応答のサンプル

Get page details in batch without sending continuation token

要求のサンプル

応答のサンプル

定義

GitVersionOptions

GitVersionType

WikiPageDetail

WikiPagesBatchRequest

WikiPageStat