Person Directory - List Dynamic Person Group Persons

Serviço:
Azure AI Services
Versão da API:
1.0-preview

Recupere a lista de pessoas referenciadas em um determinado diretório de pessoas do DynamicPersonGroup.

GET {Endpoint}/face/v1.0-preview/dynamicpersongroups/{dynamicPersonGroupId}/persons
Com parâmetros opcionais: 
GET {Endpoint}/face/v1.0-preview/dynamicpersongroups/{dynamicPersonGroupId}/persons?start={start}&top={top}

Parâmetros do URI

Name Em Necessário Tipo Description
dynamicPersonGroupId
 path True

string

ID do grupo dinâmico de pessoas para listar pessoas de
Endpoint
 path True

string

Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
start
 query

string (uuid)

Listar pessoas do menor personId maior que o "start". Não contém mais de 64 caracteres. O padrão está vazio.
top
 query

string

O número de pessoas a listar, variando em [1, 1000]. O padrão é 1000.

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Respostas

Name Tipo Description
200 OK

DynamicPersonGroupListPersonsResponse

Sucesso
Other Status Codes

Error

Entidade de resposta que acompanha respostas não bem-sucedidas contendo detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

List dynamic person group persons example

Pedido de amostra

GET {Endpoint}/face/v1.0-preview/dynamicpersongroups/abc/persons?start=25985303-c537-4467-b41d-bdb45cd95ca1&top=2

Resposta da amostra

Código de estado:
200 
{
  "personIds": [
    "25985303-c537-4467-b41d-bdb45cd95ca1",
    "2ae4935b-9659-44c3-977f-61fac20d0538"
  ]
}

Definições

Name Description
DynamicPersonGroupListPersonsResponse
Error

Corpo do erro.

DynamicPersonGroupListPersonsResponse

Object
Name Tipo Description
personIds

string[] (uuid)

Error

Object

Corpo do erro.

Name Tipo Description
code

string

message

string