🎛️ Referência — Parâmetros

GET /parametros/desconto

Consultar parâmetros de desconto · Permissão: parametro:read

404 se nunca configurado.

Respostas

• 200 — Parâmetros de desconto
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Parâmetros de desconto não configurados
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/desconto

Atualizar parâmetros de desconto · Permissão: parametro:update

Busca a linha a atualizar com findFirst() sem filtro (pega a primeira que existir, sem checar ativo/deleted). Campo omitido não altera o valor já salvo.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Row completa (inclui deleted, que não aparece no GET desta mesma rota).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/desconto/colaboradores/{nivel}

Colaboradores com permissão de um nível de desconto · Permissão: parametro:read

nivel: 1, 2 ou 3 — qualquer outro valor (inclusive não numérico) é tratado como nível 0.

Parâmetros

Respostas

• 200 — Lista de colaboradores com esse nível (só quem já tem login no sistema)
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/desconto/colaborador/{id}

Nível de alçada de desconto de um colaborador · Permissão: parametro:read

Sem DescontoColaborador cadastrado, devolve 200 com nivelAlcada: "NIVEL0" e percentual: 0 — não é 404.

Parâmetros

Respostas

• 200 — Nível de alçada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /parametros/desconto/colaborador/{id}

Conceder nível de desconto a um colaborador · Permissão: parametro:create

Hoje sempre falha por chave de API: o controller chama o use case com isAdmin fixo em false, e o use case exige isAdmin=true — toda chamada autenticada recebe 401, mesmo com o scope certo. nivel vai por query string, não pelo corpo, apesar de ser POST. Reportado ao time; documentado aqui pra não gerar confusão a mais em cima de um 401 que também é usado (em outras rotas) pra chave inválida.

Parâmetros

Respostas

• 200 — Nunca observado hoje via chave de API — ver descrição. Se um dia for liberado, o corpo é vazio (0 bytes, sem JSON).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/alcada-compra/colaborador/{id}

Alçada de compra de um colaborador · Permissão: parametro:read

Parâmetros

Respostas

• 200 — Alçada de compra — null se nunca configurada. Não existe NIVEL_1 (esse nível aprova sozinho, sem aprovador atribuível).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /parametros/alcada-compra/colaborador/{id}

Conceder alçada de compra a um colaborador · Permissão: parametro:create

Hoje sempre falha por chave de API — mesmo bug de isAdmin fixo em false da rota de nível de desconto. nivel vai por query string, não pelo corpo.

Parâmetros

Respostas

• 200 — Nunca observado hoje via chave de API — ver descrição. Se um dia for liberado, o corpo é o DTO abaixo.
• 400 — nivel inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/financeiro

Consultar parâmetros financeiros · Permissão: parametro:read

Sem configuração salva, devolve um objeto reduzido só com os 3 campos numéricos (sem id).

Respostas

• 200 — Parâmetros financeiros
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/financeiro

Atualizar parâmetros financeiros · Permissão: parametro:update

findFirst() sem filtro (pega a primeira linha que existir). Cuidado com categoriaPagamentoId/centroDeCustoId: omitir, mandar 0, "" ou false força esses dois campos para null, mesmo em cima de um registro que já tinha esses vínculos — diferente dos 3 campos numéricos, que ficam inalterados se omitidos.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Row completa.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/orcamento

Consultar parâmetros de orçamento · Permissão: parametro:read

Atenção: sem configuração salva, esta rota devolve o número 0 cru como corpo da resposta (não um objeto, não 404) — comportamento real, não documentação errada.

Respostas

• 200 — Parâmetros de orçamento, ou 0 se nunca configurado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/orcamento

Atualizar parâmetros de orçamento · Permissão: parametro:update

Inclui, entre outros, a chave que liga/desliga o bloqueio de criação pelo farol de rentabilidade (desabilitarBloqueioFarol). findFirst({where:{ativo:true}}) — diferente de desconto/financeiro, que não filtram. Nomes de campo do corpo divergem dos nomes na resposta: envie diasVencimento (não diasValidos) e consideracoes (não consideracoesGerais) — os demais batem 1:1. Sempre cria a linha se não existir (nunca devolve 0 no PUT, diferente do GET).

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Row completa.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/estoque

Consultar parâmetros de estoque · Permissão: parametro:read

Sem configuração salva, devolve { reservaMedicamentoAtiva: false } sem id.

Respostas

• 200 — Parâmetros de estoque
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/estoque

Atualizar parâmetros de estoque · Permissão: parametro:update

Inclui, entre outros, se a reserva de medicamento por paciente está ativa. Este modelo não tem campo deleted (diferente de desconto/financeiro/orçamento/termo).

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Row completa.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/avisos

Listar avisos parametrizados · Permissão: parametro:read

Catálogo fixo (hoje 3 chaves: AUTORIZACAO_VENCENDO, GRADE_PENDENTE_GUIA, GRADE_AUTORIZACAO_VENCENDO).

Respostas

• 200 — Lista de avisos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/avisos/{chave}

Consultar aviso por chave · Permissão: parametro:read

Parâmetros

Respostas

• 200 — Aviso
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Aviso não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/avisos/{chave}

Atualizar aviso · Permissão: parametro:update

chave precisa ser uma das 3 do catálogo fixo (AUTORIZACAO_VENCENDO, GRADE_PENDENTE_GUIA, GRADE_AUTORIZACAO_VENCENDO) — outra chave dá 404. Se o aviso não suporta limiar (temLimiar:false), limiar enviado é descartado silenciosamente (fica null). Efeito colateral sem impacto na resposta: invalida cache Redis para GRADE_PENDENTE_GUIA/GRADE_AUTORIZACAO_VENCENDO.

Parâmetros

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Mesmo shape do GET — nunca inclui id/createdAt/updatedAt (o aviso não é exposto como row de banco, é reconstruído a partir de um catálogo fixo no código + o que está persistido).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Aviso não existe
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/acolhimento

Consultar parâmetros de acolhimento · Permissão: parametro:read

Devolve null (200) se nunca configurado.

Respostas

• 200 — Parâmetros de acolhimento, ou null
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/acolhimento

Atualizar parâmetros de acolhimento · Permissão: parametro:update

Corpo (application/json)

Objeto livre — o Swagger publicado não detalha os campos desta rota. Consulte antes o GET correspondente para ver a estrutura atual e envie só chaves que existam nela.

Respostas

• 200 — Envelope diferente da leitura
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/acolhimento/validar/{pacienteId}

Validar dados de acolhimento de um paciente · Permissão: parametro:read

Parâmetros

Respostas

• 200 — Resultado da validação
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Paciente não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /parametros/acolhimento/atualizar-validacoes/{pacienteId}

Atualizar validações de acolhimento de um paciente · Permissão: parametro:update

Hoje sempre falha por chave de API: o controller exige req.colaborador?.id, que a autenticação por chave de API nunca popula — toda chamada recebe 401. Reportado ao time. Efeitos (não retornados, hipoteticamente se liberado): grava cpfValidadoEm/rgValidadoEm/enderecoValidadoEm/contatoValidadoEm no paciente e convenioValidadoEm nos vínculos em conveniosConfirmados, cria linhas em histórico de confirmação.

Parâmetros

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Nunca observado hoje via chave de API — ver descrição.
• 400 — pacienteId inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/acolhimento/historico-confirmacoes/{pacienteId}

Histórico de confirmações de acolhimento · Permissão: parametro:read

Parâmetros

Respostas

• 200 — Histórico, mais recente primeiro
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/servicos-online

Consultar parâmetros de agendamento online · Permissão: parametro:read

Devolve null (200) se nunca configurado.

Respostas

• 200 — Parâmetros, ou null
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/servicos-online/link

Gerar link público de agendamento online · Permissão: parametro:read

Respostas

• 200 — Link gerado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 500 — Serviço de agendamento online não configurado no ambiente
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/habilitar

Habilitar/desabilitar agendamento online · Permissão: parametro:update

O campo do corpo é habilitar, não habilitado (a spec já documentou o nome errado antes — corrigido aqui). Coerção é Boolean(habilitar) (truthy JS: qualquer string não vazia vira true; só false/0/""/null/undefined viram false). Todas as 6 rotas */habilitar mexem em UM único registro singleton (AgendamentoOnline, id fixo 1) e a resposta é sempre a linha inteira, não só o campo alterado — na primeira chamada de qualquer uma delas, os campos ainda não tocados assumem o default do schema (habilitarEtapaAgendamento começa true; os demais começam false), o que pode surpreender.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline (afeta habilitarAgendamentoOnline).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/agendamento/habilitar

Habilitar/desabilitar etapa de agendamento online · Permissão: parametro:update

Campo do corpo é habilitar, não habilitado — ver detalhes em PATCH /parametros/servicos-online/habilitar. Afeta habilitarEtapaAgendamento.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/agendamento/mudanca-colaborador/habilitar

Habilitar/desabilitar troca de colaborador no agendamento online · Permissão: parametro:update

Campo do corpo é habilitar, não habilitado — ver detalhes em PATCH /parametros/servicos-online/habilitar. Afeta permitirMudancaColaborador.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/confirmacao/habilitar

Habilitar/desabilitar etapa de confirmação no agendamento online · Permissão: parametro:update

Campo do corpo é habilitar, não habilitado — ver detalhes em PATCH /parametros/servicos-online/habilitar. Afeta habilitarEtapaConfirmacao.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/prontuario/habilitar

Habilitar/desabilitar etapa de prontuário no agendamento online · Permissão: parametro:update

Campo do corpo é habilitar, não habilitado — ver detalhes em PATCH /parametros/servicos-online/habilitar. Afeta habilitarEtapaProntuario.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/lista-medico-convenio/habilitar

Habilitar/desabilitar lista de médico por convênio no agendamento online · Permissão: parametro:update

Campo do corpo é habilitar, não habilitado — ver detalhes em PATCH /parametros/servicos-online/habilitar. Afeta habilitarListaMedicoConvenio.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PATCH /parametros/servicos-online/textos-informativos

Atualizar textos informativos do agendamento online · Permissão: parametro:update

Mesmo singleton AgendamentoOnline das rotas */habilitar — campo omitido fica inalterado (Prisma ignora undefined); na primeira criação, vira null.

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Linha completa do singleton AgendamentoOnline — inclui os 6 booleans de habilitação também, não só os textos.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/servicos-online/agendamento/perguntas

Listar perguntas do agendamento online · Permissão: parametro:read

Respostas

• 200 — Lista de perguntas
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /parametros/servicos-online/agendamento/perguntas

Criar pergunta do agendamento online · Permissão: parametro:create

Corpo (application/json) — obrigatório

Campos obrigatórios: pergunta

Respostas

• 201 — Pergunta criada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/servicos-online/agendamento/perguntas/por-especialidade

Listar perguntas por especialidade · Permissão: parametro:read

Sem especialidadeIds, só devolve as perguntas globais (sem restrição).

Parâmetros

Respostas

• 200 — Lista de perguntas
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/servicos-online/agendamento/perguntas/{id}

Atualizar pergunta do agendamento online · Permissão: parametro:update

Parâmetros

Corpo (application/json)

Nenhum campo obrigatório no nível principal.

Respostas

• 200 — Pergunta atualizada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /parametros/servicos-online/agendamento/perguntas/{id}

Excluir pergunta do agendamento online · Permissão: parametro:delete

Exclusão lógica (deleted = true).

Parâmetros

Respostas

• 204 — Pergunta excluída — sem corpo de resposta
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/servicos-online/agendamento/perguntas/colaborador/{colaboradorId}

Listar perguntas vinculadas a um colaborador · Permissão: parametro:read

Parâmetros

Respostas

• 200 — Lista de perguntas
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /parametros/servicos-online/agendamento/perguntas/{perguntaId}/colaborador/{colaboradorId}

Vincular pergunta a um colaborador · Permissão: parametro:update

Idempotente (upsert numa chave composta, sem PK própria e sem timestamps). Não valida antecipadamente se perguntaId/colaboradorId existem — se algum não existir, a violação de FK do Postgres tende a virar um erro não tratado (500), diferente de outras rotas do módulo que checam antes com AppError.

Parâmetros

Respostas

• 200 — Só as duas colunas da chave composta — note que o campo é perguntaAgendamentoId, não perguntaId como no path.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/termo

Consultar parâmetros de termo de consentimento · Permissão: parametro:read

Devolve null (200) se nunca configurado.

Respostas

• 200 — Parâmetros de termo, ou null
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/termo

Atualizar parâmetros de termo de consentimento · Permissão: parametro:update

Único PUT deste grupo que valida de verdade: conteudo é obrigatório. findFirst({where:{ativo:true, deleted:false}}).

Corpo (application/json) — obrigatório

Campos obrigatórios: conteudo

Respostas

• 200 — Row completa — inclui createdAt/updatedAt/deleted, que o GET desta mesma rota não lista hoje.
• 400 — O conteúdo do termo é obrigatório
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/dashboard-permissoes/graficos

Consultar permissão de gráficos de dashboard · Permissão: parametro:read

Controle de acesso a telas, não parâmetro de negócio. perfilPermissaoId é obrigatório na query.

Parâmetros

Respostas

• 200 — Permissões
• 400 — perfilPermissaoId ausente/inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/dashboard-permissoes/graficos

Atualizar permissão de gráficos de dashboard · Permissão: parametro:update

Controle de acesso: define quem vê quais gráficos.

Corpo (application/json)

Campos obrigatórios: perfilPermissaoId, permissoes

Respostas

• 200 — Confirmação, sem devolver os dados salvos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/dashboard-permissoes/dashboards

Consultar permissão de dashboards · Permissão: parametro:read

Controle de acesso a telas, não parâmetro de negócio. perfilPermissaoId é obrigatório na query.

Parâmetros

Respostas

• 200 — Permissões
• 400 — perfilPermissaoId ausente/inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/dashboard-permissoes/dashboards

Atualizar permissão de dashboards · Permissão: parametro:update

Controle de acesso: define quem vê quais painéis.

Corpo (application/json)

Campos obrigatórios: perfilPermissaoId, permissoes

Respostas

• 200 — Confirmação, sem devolver os dados salvos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /parametros/dashboard-atribuicao

Consultar atribuição de dashboard · Permissão: parametro:read

perfilPermissaoId é obrigatório na query — diferente das duas rotas de permissão acima, esta não ecoa o valor de volta na resposta.

Parâmetros

Respostas

• 200 — Atribuições
• 400 — perfilPermissaoId ausente
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /parametros/dashboard-atribuicao

Atualizar atribuição de dashboard · Permissão: parametro:update

Controle de acesso: define qual dashboard cada colaborador/grupo enxerga.

Corpo (application/json)

Campos obrigatórios: perfilPermissaoId, dashboardIds

Respostas

• 200 — Confirmação, sem devolver os dados salvos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si