Collections - List Child Collection Names

Referencia

Servicio:: Purview

Versión de la API:: 2019-11-01-preview

Enumera los nombres de colecciones secundarias de la colección.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collectionName	path	True	string
endpoint	path	True	string	Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	La versión de api que se va a usar.
$skipToken	query		string

Respuestas

Nombre	Tipo	Description
200 OK	CollectionNameResponseList	Correcto
Other Status Codes	ErrorResponseModel	Respuesta de error recibida del proveedor.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Collections_ListChildCollectionNames

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

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

Definiciones

Nombre	Description
CollectionNameResponse	Recurso de colección.
CollectionNameResponseList	Lista paginada de colecciones.
Error	Obtiene o establece el error.
ErrorModel	Modelo de error predeterminado
ErrorResponseModel	Modelo de respuesta de error predeterminado

CollectionNameResponse

Recurso de colección.

Nombre	Tipo	Description
friendlyName	string	Obtiene o establece el nombre descriptivo de la colección.
name	string	Obtiene el nombre.

CollectionNameResponseList

Lista paginada de colecciones.

Nombre	Tipo	Description
count	integer	Recuento total de elementos.
nextLink	string	Dirección URL de la página de resultados siguiente.
value	CollectionNameResponse[]	Colección de elementos de tipo resultados.

Error

Obtiene o establece el error.

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorModel

Modelo de error predeterminado

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorResponseModel

Modelo de respuesta de error predeterminado

Nombre	Tipo	Description
error	Error	Obtiene o establece el error.

Compartir a través de