Collections - Get Collection Path

Service:

Purview

API Version:

2019-11-01-preview

Gets the parent name and parent friendly name chains that represent the collection path.

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

URI Parameters

Name	In	Required	Type	Description
collectionName	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.

Responses

Name	Type	Description
200 OK	CollectionPathResponse	Success
Other Status Codes	ErrorResponseModel	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_GetCollectionPath

Sample Request

HTTP

GET {endpoint}/collections/myCollection1/getCollectionPath?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

{
  "parentNameChain": [
    "account1",
    "parent1"
  ],
  "parentFriendlyNameChain": [
    "Test account  friendly name",
    "parent1"
  ]
}

Definitions

Name	Description
CollectionPathResponse	Collection resource.
Error	Gets or sets the error.
ErrorModel	Default error model
ErrorResponseModel	Default error response model

CollectionPathResponse

Collection resource.

Name	Type	Description
parentFriendlyNameChain	string[]	The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent.
parentNameChain	string[]	The names of ancestors starting from the default (root) collection and ending with the immediate parent.

Error

Gets or sets the error.

Name	Type	Description
code	string	Gets or sets the code.
details	ErrorModel[]	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	ErrorModel[]	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	Error	Gets or sets the error.