Parâmetros
Parâmetros da plataforma e da instituição, com herança entre os níveis.
Lê os parâmetros da instituição
GET /instituicoes/{instituicaoId}/parametros
Acesso: Exige a capacidade ADMINISTRAR sobre instituição (params.instituicaoId). Status de sucesso: 200.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
instituicaoId | string (uuid) | sim | Id da instituição. |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sim | ||
valores | object | sim | ||
herdados | object | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/instituicoes/{instituicaoId}/parametros" -H "Authorization: Bearer $TOKEN"Atualiza os parâmetros da instituição
PUT /instituicoes/{instituicaoId}/parametros
Acesso: Exige a capacidade ADMINISTRAR sobre instituição (params.instituicaoId). Status de sucesso: 200.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
instituicaoId | string (uuid) | sim | Id da instituição. |
Corpo da requisição (ParametrosInstituicaoAtualizar)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
turma.tolerancia_antes_min | integer ou nulo | não | 0…720 | |
turma.tolerancia_depois_min | integer ou nulo | não | 0…720 | |
senha.tamanho_minimo | integer ou nulo | não | 8…128 | |
senha.historico | integer ou nulo | não | 0…24 | |
senha.intervalo_min_horas | integer ou nulo | não | 0…168 | |
sessao.expira_dias | integer ou nulo | não | 1…365 | |
auditoria.retencao_meses | integer ou nulo | não | 1…240 | |
lembrete.atividade_antecedencia_min | integer ou nulo | não | 0…1440 | |
lembrete.avaliador_pendencia_horas | integer ou nulo | não | 0…168 | |
notificacao.silencio_inicio_h | integer ou nulo | não | 0…23 | |
notificacao.silencio_fim_h | integer ou nulo | não | 0…23 | |
sus.convite_intervalo_dias | integer ou nulo | não | 0…730 | |
feedback.prazo_dias | integer ou nulo | não | 0…180 | |
chat.retencao_meses | integer ou nulo | não | 1…240 |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sim | ||
valores | object | sim | ||
herdados | object | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X PUT "$API/instituicoes/{instituicaoId}/parametros" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'Lê os parâmetros da plataforma
GET /parametros
Acesso: Exige a capacidade PLATAFORMA. Status de sucesso: 200.
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sim | ||
valores | object | sim | ||
herdados | object | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/parametros" -H "Authorization: Bearer $TOKEN"Atualiza os parâmetros da plataforma
PUT /parametros
Acesso: Exige a capacidade PLATAFORMA. Status de sucesso: 200.
Corpo da requisição (ParametrosPlataformaAtualizar)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
turma.tolerancia_antes_min | integer ou nulo | não | 0…720 | |
turma.tolerancia_depois_min | integer ou nulo | não | 0…720 | |
senha.tamanho_minimo | integer ou nulo | não | 8…128 | |
senha.historico | integer ou nulo | não | 0…24 | |
senha.intervalo_min_horas | integer ou nulo | não | 0…168 | |
sessao.expira_dias | integer ou nulo | não | 1…365 | |
auditoria.retencao_meses | integer ou nulo | não | 1…240 | |
dados.retencao_meses | integer ou nulo | não | 1…240 | |
lembrete.atividade_antecedencia_min | integer ou nulo | não | 0…1440 | |
lembrete.avaliador_pendencia_horas | integer ou nulo | não | 0…168 | |
notificacao.silencio_inicio_h | integer ou nulo | não | 0…23 | |
notificacao.silencio_fim_h | integer ou nulo | não | 0…23 | |
sus.convite_intervalo_dias | integer ou nulo | não | 0…730 | |
feedback.prazo_dias | integer ou nulo | não | 0…180 | |
chat.retencao_meses | integer ou nulo | não | 1…240 | |
notificacao.retencao_dias | integer ou nulo | não | 1…3650 |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sim | ||
valores | object | sim | ||
herdados | object | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X PUT "$API/parametros" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'