Nunciatura Provista

API Documentation V1

Atualizar Processo

Atualiza dados de um processo existente

Este endpoint é do tipo: Protected

Descrição

Atualiza um processo existente com as seguintes funcionalidades:

  • Permite atualizar apenas os campos enviados (parcial)
  • Valida unicidade do protocolo (exceto o próprio processo)
  • Mantém histórico de alterações
  • Valida regras de negócio específicas
  • Retorna o processo atualizado
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

PUT

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/processes/{id}

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Content-Type application/json
Accept application/json

Parâmetros da URL

Parâmetro Tipo Obrigatório Descrição
id string Sim UUID do processo a ser atualizado

Corpo da Requisição

Campo Tipo Obrigatório Descrição
name string Não Nome do processo (máx: 255 caracteres)
protocol string Não Protocolo no formato PROV-YYYY-XXX (ex: PROV-2024-001)
description string Não Descrição detalhada do processo
users integer Não Número total de usuários esperados (mín: 1)
users_collected integer Não Número de usuários já coletados (mín: 0)
img_url string Não URL da imagem do processo (máx: 500 caracteres)
status string Não Status: "A iniciar", "Em andamento" ou "Concluído"

Exemplo de Requisição

{
  "name": "Diocese de São Paulo - Atualizado",
  "protocol": "PROV-2024-001",
  "description": "Processo de provisão para Diocese de São Paulo (atualizado)"
}

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Processo atualizado com sucesso",
  "data": {
    "id": "uuid-processo-1",
    "name": "Diocese de São Paulo - Atualizado",
    "protocol": "PROV-2024-001",
    "description": "Processo de provisão para Diocese de São Paulo (atualizado)",
    "initials": "DS",
    "informers_total": 25,
    "answers": { "received": 18, "expected": 300, "label": "18/300" },
    "status": "Em andamento",
    "groups_summary": [
      {"id": "uuid-g1", "code": "G1", "name": "Grupo 1", "color": "#845ADF", "informers_count": 25, "questionnaires_count": 3, "answers_received": 12, "answers_expected": 75}
    ],
    "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 - 422 (Validação)

{
  "success": false,
  "message": "Erro de validação",
  "errors": {
    "protocol": ["Este protocolo já está cadastrado no sistema."],
    "users": ["O número de usuários deve ser maior que 0."]
  }
}

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Códigos de Resposta

Código Descrição
200 Processo atualizado com sucesso
401 Token inválido ou expirado
404 Processo não encontrado
422 Erro de validação dos dados