Collections - List Child Collection Names

Service:

Purview

API Version:

2019-11-01-preview

コレクション内の子コレクション名を一覧表示します。

GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview

With optional parameters:

GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview&$skipToken={$skipToken}

URI パラメーター

名前	/	必須	型	説明
collectionName	path	True	string
endpoint	path	True	string	Purview アカウントのアカウント エンドポイント。 例: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	使用する API バージョン。
$skipToken	query		string

応答

名前	型	説明
200 OK	CollectionNameResponseList	Success
Other Status Codes	ErrorResponseModel	プロバイダーから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Collections_ListChildCollectionNames

Sample Request

HTTP

GET {endpoint}/collections/myCollection1/getChildCollectionNames?api-version=2019-11-01-preview

Sample Response

Status code:

200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

Response Body

{
  "value": [
    {
      "name": "mycollection1",
      "friendlyName": "The first collection"
    },
    {
      "name": "mycollection2",
      "friendlyName": "Some collection"
    },
    {
      "name": "parent2",
      "friendlyName": "parent2"
    }
  ],
  "count": 3
}

定義

名前	説明
CollectionNameResponse	コレクション リソース。
CollectionNameResponseList	コレクションのページ一覧。
Error	エラーを取得または設定します。
ErrorModel	既定のエラー モデル
ErrorResponseModel	既定のエラー応答モデル

CollectionNameResponse

コレクション リソース。

名前	型	説明
friendlyName	string	コレクションのフレンドリ名を取得または設定します。
name	string	名前を取得します。

CollectionNameResponseList

コレクションのページ一覧。

名前	型	説明
count	integer	アイテム数の合計。
nextLink	string	次の結果ページの URL。
value	CollectionNameResponse[]	結果の型の項目のコレクション。

Error

エラーを取得または設定します。

名前	型	説明
code	string	コードを取得または設定します。
details	ErrorModel[]	詳細を取得または設定します。
message	string	メッセージを取得または設定します。
target	string	ターゲットを取得または設定します。

ErrorModel

既定のエラー モデル

名前	型	説明
code	string	コードを取得または設定します。
details	ErrorModel[]	詳細を取得または設定します。
message	string	メッセージを取得または設定します。
target	string	ターゲットを取得または設定します。

ErrorResponseModel

既定のエラー応答モデル

名前	型	説明
error	Error	エラーを取得または設定します。