Collections - List Child Collection Names

Riferimento

Servizio:: Purview

Versione API:: 2019-11-01-preview

Elenchi i nomi delle raccolte figlio nell'insieme.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
collectionName	path	True	string
endpoint	path	True	string	Endpoint dell'account Purview. Esempio: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Versione dell'API da usare.
$skipToken	query		string

Risposte

Nome	Tipo	Descrizione
200 OK	CollectionNameResponseList	Operazione riuscita
Other Status Codes	ErrorResponseModel	Risposta di errore ricevuta dal provider.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Collections_ListChildCollectionNames

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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

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

Definizioni

Nome	Descrizione
CollectionNameResponse	Risorsa raccolta.
CollectionNameResponseList	Elenco paginato delle raccolte.
Error	Ottiene o imposta l'errore.
ErrorModel	Modello di errore predefinito
ErrorResponseModel	Modello di risposta degli errori predefinito

CollectionNameResponse

Risorsa raccolta.

Nome	Tipo	Descrizione
friendlyName	string	Ottiene o imposta il nome descrittivo della raccolta.
name	string	Ottiene il nome.

CollectionNameResponseList

Elenco paginato delle raccolte.

Nome	Tipo	Descrizione
count	integer	Numero totale di elementi.
nextLink	string	Url della pagina dei risultati successiva.
value	CollectionNameResponse[]	Raccolta di elementi di tipo risultati.

Error

Ottiene o imposta l'errore.

Nome	Tipo	Descrizione
code	string	Ottiene o imposta il codice.
details	ErrorModel[]	Ottiene o imposta i dettagli.
message	string	Ottiene o imposta i messaggi.
target	string	Ottiene o imposta la destinazione.

ErrorModel

Modello di errore predefinito

Nome	Tipo	Descrizione
code	string	Ottiene o imposta il codice.
details	ErrorModel[]	Ottiene o imposta i dettagli.
message	string	Ottiene o imposta i messaggi.
target	string	Ottiene o imposta la destinazione.

ErrorResponseModel

Modello di risposta degli errori predefinito

Nome	Tipo	Descrizione
error	Error	Ottiene o imposta l'errore.

Condividi tramite