Parámetros
Parámetros de la plataforma y de la institución, con herencia entre niveles.
Lee los parámetros de la institución
GET /instituicoes/{instituicaoId}/parametros
Acceso: Exige la capacidad ADMINISTRAR sobre institución (params.instituicaoId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
instituicaoId | string (uuid) | sí | Id de la institución. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sí | ||
valores | object | sí | ||
herdados | object | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/instituicoes/{instituicaoId}/parametros" -H "Authorization: Bearer $TOKEN"Actualiza los parámetros de la institución
PUT /instituicoes/{instituicaoId}/parametros
Acceso: Exige la capacidad ADMINISTRAR sobre institución (params.instituicaoId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
instituicaoId | string (uuid) | sí | Id de la institución. |
Cuerpo de la solicitud (ParametrosInstituicaoAtualizar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turma.tolerancia_antes_min | integer o nulo | no | 0…720 | |
turma.tolerancia_depois_min | integer o nulo | no | 0…720 | |
senha.tamanho_minimo | integer o nulo | no | 8…128 | |
senha.historico | integer o nulo | no | 0…24 | |
senha.intervalo_min_horas | integer o nulo | no | 0…168 | |
sessao.expira_dias | integer o nulo | no | 1…365 | |
auditoria.retencao_meses | integer o nulo | no | 1…240 | |
lembrete.atividade_antecedencia_min | integer o nulo | no | 0…1440 | |
lembrete.avaliador_pendencia_horas | integer o nulo | no | 0…168 | |
notificacao.silencio_inicio_h | integer o nulo | no | 0…23 | |
notificacao.silencio_fim_h | integer o nulo | no | 0…23 | |
sus.convite_intervalo_dias | integer o nulo | no | 0…730 | |
feedback.prazo_dias | integer o nulo | no | 0…180 | |
chat.retencao_meses | integer o nulo | no | 1…240 |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sí | ||
valores | object | sí | ||
herdados | object | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PUT "$API/instituicoes/{instituicaoId}/parametros" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'Lee los parámetros de la plataforma
GET /parametros
Acceso: Exige la capacidad PLATAFORMA. Estado de éxito: 200.
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sí | ||
valores | object | sí | ||
herdados | object | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/parametros" -H "Authorization: Bearer $TOKEN"Actualiza los parámetros de la plataforma
PUT /parametros
Acceso: Exige la capacidad PLATAFORMA. Estado de éxito: 200.
Cuerpo de la solicitud (ParametrosPlataformaAtualizar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turma.tolerancia_antes_min | integer o nulo | no | 0…720 | |
turma.tolerancia_depois_min | integer o nulo | no | 0…720 | |
senha.tamanho_minimo | integer o nulo | no | 8…128 | |
senha.historico | integer o nulo | no | 0…24 | |
senha.intervalo_min_horas | integer o nulo | no | 0…168 | |
sessao.expira_dias | integer o nulo | no | 1…365 | |
auditoria.retencao_meses | integer o nulo | no | 1…240 | |
dados.retencao_meses | integer o nulo | no | 1…240 | |
lembrete.atividade_antecedencia_min | integer o nulo | no | 0…1440 | |
lembrete.avaliador_pendencia_horas | integer o nulo | no | 0…168 | |
notificacao.silencio_inicio_h | integer o nulo | no | 0…23 | |
notificacao.silencio_fim_h | integer o nulo | no | 0…23 | |
sus.convite_intervalo_dias | integer o nulo | no | 0…730 | |
feedback.prazo_dias | integer o nulo | no | 0…180 | |
chat.retencao_meses | integer o nulo | no | 1…240 | |
notificacao.retencao_dias | integer o nulo | no | 1…3650 |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
nivel | "plataforma" | "instituicao" | sí | ||
valores | object | sí | ||
herdados | object | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PUT "$API/parametros" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'