Collections - List Child Collection Names
Lists the child collections names in the collection.
GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview
GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
collection
|
path | True |
string |
|
endpoint
|
path | True |
string |
The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/ |
api-version
|
query | True |
string |
The api version to use. |
$skip
|
query |
string |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
An error response received from the provider. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Collections_ListChildCollectionNames
Sample request
GET {endpoint}/collections/myCollection1/getChildCollectionNames?api-version=2019-11-01-preview
Sample response
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
{
"value": [
{
"name": "mycollection1",
"friendlyName": "The first collection"
},
{
"name": "mycollection2",
"friendlyName": "Some collection"
},
{
"name": "parent2",
"friendlyName": "parent2"
}
],
"count": 3
}
Definitions
Name | Description |
---|---|
Collection |
Collection resource. |
Collection |
Paged list of collections. |
Error |
Gets or sets the error. |
Error |
Default error model |
Error |
Default error response model |
CollectionNameResponse
Collection resource.
Name | Type | Description |
---|---|---|
friendlyName |
string |
Gets or sets the friendly name of the collection. |
name |
string |
Gets the name. |
CollectionNameResponseList
Paged list of collections.
Name | Type | Description |
---|---|---|
count |
integer |
Total item count. |
nextLink |
string |
The Url of next result page. |
value |
Collection of items of type results. |
Error
Gets or sets the error.
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the code. |
details |
Gets or sets the details. |
|
message |
string |
Gets or sets the messages. |
target |
string |
Gets or sets the target. |
ErrorModel
Default error model
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the code. |
details |
Gets or sets the details. |
|
message |
string |
Gets or sets the messages. |
target |
string |
Gets or sets the target. |
ErrorResponseModel
Default error response model
Name | Type | Description |
---|---|---|
error |
Gets or sets the error. |