Collections - List Child Collection Names

Referenz

Service:: Purview

API Version:: 2019-11-01-preview

Listet die Namen der untergeordneten Sammlungen in der Sammlung auf.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collectionName	path	True	string
endpoint	path	True	string	Der Kontoendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Die zu verwendende API-Version.
$skipToken	query		string

Antworten

Name	Typ	Beschreibung
200 OK	CollectionNameResponseList	Erfolg
Other Status Codes	ErrorResponseModel	Eine vom Anbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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
}

Definitionen

Name	Beschreibung
CollectionNameResponse	Sammlungsressource.
CollectionNameResponseList	Ausgelagerte Liste der Sammlungen.
Error	Ruft den Fehler ab oder legt den Fehler fest.
ErrorModel	Standardfehlermodell
ErrorResponseModel	Standardfehlerantwortmodell

CollectionNameResponse

Sammlungsressource.

Name	Typ	Beschreibung
friendlyName	string	Ruft den Anzeigenamen der Auflistung ab oder legt den Anzeigenamen fest.
name	string	Ruft den Namen ab.

CollectionNameResponseList

Ausgelagerte Liste der Sammlungen.

Name	Typ	Beschreibung
count	integer	Gesamtanzahl der Elemente.
nextLink	string	Die URL der nächsten Ergebnisseite.
value	CollectionNameResponse[]	Sammlung von Elementen vom Typ Ergebnisse.

Error

Ruft den Fehler ab oder legt den Fehler fest.

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt sie fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorModel

Standardfehlermodell

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt sie fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorResponseModel

Standardfehlerantwortmodell

Name	Typ	Beschreibung
error	Error	Ruft den Fehler ab oder legt den Fehler fest.

Freigeben über