Collections - List Child Collection Names

Référence

Service:: Purview

Version d'API:: 2019-11-01-preview

Dresse la liste des noms des collections enfants de la collection.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectionName	path	True	string
endpoint	path	True	string	Point de terminaison de compte de votre compte Purview. Exemple : https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Version de l’API à utiliser.
$skipToken	query		string

Réponses

Nom	Type	Description
200 OK	CollectionNameResponseList	Succès
Other Status Codes	ErrorResponseModel	Réponse d’erreur reçue du fournisseur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Collections_ListChildCollectionNames

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
}

Définitions

Nom	Description
CollectionNameResponse	Ressource de collection.
CollectionNameResponseList	Liste paginée des collections.
Error	Obtient ou définit l’erreur.
ErrorModel	Modèle d’erreur par défaut
ErrorResponseModel	Modèle de réponse d’erreur par défaut

CollectionNameResponse

Ressource de collection.

Nom	Type	Description
friendlyName	string	Obtient ou définit le nom convivial de la collection.
name	string	Obtient le nom.

CollectionNameResponseList

Liste paginée des collections.

Nom	Type	Description
count	integer	Nombre total d’éléments.
nextLink	string	Url de la page de résultats suivante.
value	CollectionNameResponse[]	Collection d’éléments de type résultats.

Error

Obtient ou définit l’erreur.

Nom	Type	Description
code	string	Obtient ou définit le code.
details	ErrorModel[]	Obtient ou définit les détails.
message	string	Obtient ou définit les messages.
target	string	Obtient ou définit la cible.

ErrorModel

Modèle d’erreur par défaut

Nom	Type	Description
code	string	Obtient ou définit le code.
details	ErrorModel[]	Obtient ou définit les détails.
message	string	Obtient ou définit les messages.
target	string	Obtient ou définit la cible.

ErrorResponseModel

Modèle de réponse d’erreur par défaut

Nom	Type	Description
error	Error	Obtient ou définit l’erreur.

Partager via