Tema
Destinatários de atribuição
Quem pode receber uma ocorrência nesta empresa, já com o Kind que a atribuição espera.
GET /assigneesPermissão · masterdata:read
Pedido
bash
curl "https://servidor.exemplo/api/integrations/v1/acme/assignees" \
-H "ApiKey: $GC_API_KEY"Resposta · 200
Array simples, sem envelope.
json
[
{ "Kind": "user", "Id": 14, "Name": "Ana Costa" },
{ "Kind": "user", "Id": 15, "Name": "Rui Marques" }
]| Campo | Tipo | Descrição |
|---|---|---|
Kind | texto | O tipo de destinatário. user, technician ou supplier |
Id | inteiro | Identificador |
Name | texto | Nome |
O que devolve depende da empresa
| Origem das ocorrências | Devolve | Kind |
|---|---|---|
GC | Os utilizadores da empresa | user |
GM | Os técnicos do centro de manutenção | technician |
Nas empresas em GC, uma ocorrência pode ainda ser entregue a um fornecedor — esses não vêm daqui, vêm de /suppliers, e usam-se com Kind a supplier.
Chame este ponto em vez de fixar o tipo no código
Devolve já o Kind certo para a empresa em causa. Assim a sua integração funciona nos dois casos sem ter de saber qual é, e a tabela acima fica num sítio só: aqui. Ver Ocorrências: GC ou GM.
Usar numa atribuição
O que sai daqui entra diretamente na atribuição, sem conversão:
bash
curl -X POST "https://servidor.exemplo/api/integrations/v1/acme/occurrences/501/assignment" \
-H "ApiKey: $GC_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"AssignedTo": { "Kind": "user", "Id": 14 },
"Note": "Entregue à gestão do condomínio para orçamentação.",
"Notify": false
}'O name é ignorado na escrita — só o Kind e o Id contam.
Erros
| Estado | Código | Quando |
|---|---|---|
401 | INVALID_KEY · KEY_REVOKED · KEY_EXPIRED | Ver Autenticação |
403 | FORBIDDEN_SCOPE | A credencial não tem masterdata:read |
502 | UPSTREAM_UNAVAILABLE | Numa empresa em GM, esse sistema não respondeu |