Person Directory - List Dynamic Person Group Person References

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

Liste os grupos dinâmicos de pessoas nos quais uma pessoa foi referenciada.

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

Parâmetros do URI

Name Em Necessário Tipo Description
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).
personId
 path True

string (uuid)

PersonId válido criado a partir de Person Create.
start
 query

string

Liste o id do grupo dinâmico de pessoas do menos dynamicPersonGroupId maior que o "start". Não contém mais de 64 caracteres. O padrão está vazio.
top
 query

string

O número de dynamicPersonGroupId para 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

PersonDynamicPersonGroupReferenceResponse

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 references example

Pedido de amostra

GET {Endpoint}/face/v1.0-preview/persons/1d44651f-fadb-41f5-8918-c30609964489/dynamicPersonGroupReferences

Resposta da amostra

Código de estado:
200 
{
  "personId": "1d44651f-fadb-41f5-8918-c30609964489",
  "dynamicPersonGroupIds": [
    "dynamicPersonGroup1",
    "dynamicPersonGroup2"
  ]
}

Definições

Name Description
Error

Corpo do erro.
PersonDynamicPersonGroupReferenceResponse

Error

Object

Corpo do erro.

Name Tipo Description
code

string

message

string

PersonDynamicPersonGroupReferenceResponse

Object
Name Tipo Description
dynamicPersonGroupIds

string[]

personId

string (uuid)