Collections - List Child Collection Names

Referência

Serviço:: Purview

Versão da API:: 2019-11-01-preview

Lista os nomes das coleções filho na coleção.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
collectionName	path	True	string
endpoint	path	True	string	O ponto de extremidade da conta do Purview. Exemplo: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	A versão da API a ser usada.
$skipToken	query		string

Respostas

Nome	Tipo	Description
200 OK	CollectionNameResponseList	Êxito
Other Status Codes	ErrorResponseModel	Uma resposta de erro recebida do provedor.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Collections_ListChildCollectionNames

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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
}

Definições

Nome	Description
CollectionNameResponse	Recurso de coleção.
CollectionNameResponseList	Lista de coleções paginada.
Error	Obtém ou define o erro.
ErrorModel	Modelo de erro padrão
ErrorResponseModel	Modelo de resposta de erro padrão

CollectionNameResponse

Recurso de coleção.

Nome	Tipo	Description
friendlyName	string	Obtém ou define o nome amigável da coleção.
name	string	Obtém o nome.

CollectionNameResponseList

Lista de coleções paginada.

Nome	Tipo	Description
count	integer	Contagem total de itens.
nextLink	string	A URL da próxima página de resultados.
value	CollectionNameResponse[]	Coleção de itens de resultados de tipo.

Error

Obtém ou define o erro.

Nome	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorModel

Modelo de erro padrão

Nome	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorResponseModel

Modelo de resposta de erro padrão

Nome	Tipo	Description
error	Error	Obtém ou define o erro.

Compartilhar via