Get Process By ID
Retorna os detalhes de um processo específico
Descrição
Retorna os detalhes completos de um processo específico com as seguintes informações:
- Dados do processo: name, protocol, description, initials
- Total de informadores: informers_total
- Contagem de respostas: answers.received, answers.expected e rótulo answers.label (ex.: "18/300")
- Status calculado: A iniciar | Em andamento | Concluído
- Resumo por grupo (groups_summary): G1..G6 com cor, informers_count, questionnaires_count, answers_received e answers_expected
- Timestamps de criação e atualização
- Valida se o processo existe
- Requer autenticação JWT válida
Detalhes do Endpoint
VERBO
GET
URL BASE
http://api.provista.dev.nabrasil.org.br/v1
ENDPOINT
/processes/{id}
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer <token> |
| Accept | application/json |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | string | Sim | UUID do processo a ser consultado |
Respostas
Sucesso - 200
{
"success": true,
"data": {
"id": "uuid-processo-1",
"name": "Arquidiocese de São Paulo",
"protocol": "PROV-2024-001",
"description": "Processo de provisão para a Arquidiocese de São Paulo",
"initials": "AS",
"informers_total": 25,
"answers": {
"received": 18,
"expected": 300,
"label": "18/300"
},
"status": "Em andamento",
"groups_summary": [
{
"id": "uuid-grupo-1",
"code": "G1",
"name": "Grupo 1",
"color": "#845ADF",
"informers_count": 25,
"questionnaires_count": 3,
"answers_received": 12,
"answers_expected": 75
},
{
"id": "uuid-grupo-2",
"code": "G2",
"name": "Grupo 2",
"color": "#26BF94",
"informers_count": 25,
"questionnaires_count": 1,
"answers_received": 3,
"answers_expected": 25
}
],
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-15T10:30:00.000000Z"
}
}
Erro - 404 (Processo não encontrado)
{
"success": false,
"message": "Processo não encontrado"
}
Erro - 401 (Token inválido)
{
"success": false,
"message": "Token não fornecido"
}
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Processo retornado com sucesso |
| 401 | Token inválido ou expirado |
| 404 | Processo não encontrado |