Endpoint que lista todas as ocorrências de autocorreção de constantes cadastradas.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/constant-occurrences | Content-Type:application/json | Authorization: Bearer {token} |
_sort: 'id' (string) - ('id', 'constant_value') - "Define o campo de ordenação da lista."
_order: 'desc' (string) - ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."
constant_value: 0.98 (float) - "Valor da constante sugerida"
device_id: 1 (integer) - "Id do dispositivo"
initial_date: '2025-01-01' - (date) "Período inicial do registro de autocorreção de constantes"
closed: 1 (boolean) - "Indica se a autocorreção de constantes está aberta ou fechada",
equipment_id: 1 (integer) - "Id do equipamento"
account_id: 1 (integer) - "Id da conta"{success} Response 200 (application/json)
{
"items": [
{
"id": 1,
"initial_date": "2024-12-01",
"verified_at": "2025-01-01",
"constant_value": 1,
"zordon_occurrences_summary": null,
"scde_occurrences_summary": null,
"closed": true,
"device": {
"id": 1,
"code": "882164"
},
"equipment": {
"id": 22,
"name": "Fonseca e Mascarenhas"
},
"company": {
"id": 6,
"name": "Empresa 1"
}
}
],
"total": 1,
"per_page": 10,
"current_page": 1
}{primary} Response 204 (application/json).
Quando os critérios de parâmetros não contiver registros a serem retornados.
{warning} Response 422 (application/json)
{
"_sort": [
"O campo sort selecionado é inválido."
],
"_order": [
"O campo order selecionado é inválido."
],
"_limit": [
"O campo limit deve ser um número inteiro."
],
"_page": [
"O campo page deve ser um número inteiro."
]
}{warning} Response 403 (application/json)
"Permissões insuficientes!"
Endpoint que detalha uma ocorrência de autocorreção de constante específica.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/constant-occurrences/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes"{success} Response 200 (application/json)
{
"id": 1,
"initial_date": "2024-12-01",
"verified_at": "2025-01-01",
"constant_value": 1,
"zordon_occurrences_summary": null,
"scde_occurrences_summary": null,
"closed": true,
"device": {
"id": 1,
"code": "882164",
"equipment": {
"id": 1,
"name": "TRAFO 03"
}
},
"constant_occurrence_details": {
"id": 1,
"zordon_occurrences": null,
"scde_occurrences": [
1736128800,
1736125200
]
}
}{primary} Response 404 (application/json)
Quando o registro não existir.
{warning} Response 422 (application/json)
Quando o usuário não tiver permissão de visualização.
Endpoint que cria uma ocorrência de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences | Content-Type:application/json | Authorization: Bearer {token} |
device_id: 1 (integer, required) - "Id do Dispositivo.",
initial_date: "2025-01-01" (string, required) - "Data inicial do período da autocorreção de constantes",
constant_value: 1 (double) - "Valor da constante sugerida"{success} Response 201 (application/json)
{
"id": 1,
"initial_date": "2024-12-01",
"verified_at": "2025-01-01",
"constant_value": 1,
"zordon_occurrences_summary": null,
"scde_occurrences_summary": null,
"closed": true,
"device": {
"id": 1,
"code": "882164",
"equipment": {
"id": 1,
"name": "TRAFO 03"
}
}
}{warning} Response 422 (application/json)
Quando o usuário enviar algum campo com valor incorreto ou sem permissão para visualização do dispositivo em questão.
{
"device_id": [
"O campo dispositivo selecionado é inválido.",
"Já existe uma análise de constantes em aberto para este dispositivo"
],
"initial_date": [
"O campo data inicial não corresponde ao formato Y-m-d."
],
"closed": [
"O campo closed deve ser verdadeiro ou falso."
]
}Endpoint que atualiza uma ocorrência de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| PUT | /api/v3/constant-occurrence/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes"closed: 3 (boolean) - "Indica se uma ocorrência de autocorreção de constantes está aberta ou fechada.",
initial_date: "2025-01-01" (string) - "Indica a data de inicio do calculo de constante."{success} Response 200 (application/json)
{
"id": 1,
"initial_date": "2024-12-01",
"verified_at": "2025-01-01",
"constant_value": 1,
"zordon_occurrences_summary": null,
"scde_occurrences_summary": null,
"closed": true,
"device": {
"id": 1,
"code": "882164",
"equipment": {
"id": 1,
"name": "TRAFO 03"
}
}
}{warning} Response 422 (application/json)
Quando o usuário enviar algum campo com valor incorreto ou sem permissão para visualização do dispositivo em questão.
{
"device_id": [
"O campo dispositivo selecionado é inválido.",
"Já existe uma análise de constantes em aberto para este dispositivo"
],
"initial_date": [
"O campo data inicial não corresponde ao formato Y-m-d."
],
"closed": [
"O campo closed deve ser verdadeiro ou falso."
]
}{primary} Response 404 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que deleta uma ocorrência de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| DELETE | /api/v3/constant-occurrences/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes"{success} Response 204 (application/json)
Quando o registro for excluído com sucesso.
{warning} Response 404 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que aplica uma constante sugerida.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences/{id}/apply | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes"initial_date: "2025-01-01" (string, required) - "Data inicial do período da ocorrência de autocorreção de constantes",
constant_value: 1 (double, required) - "Valor da constante sugerida",
reprocess: 1 (boolean, required) - "Indica se deve reprocessar as medições com o valor da nova constante aplicada"{success} Response 201 (application/json)
Quando a constante for aplicada às constantes de dispositivo.
{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
Endpoint que processa uma ocorrência de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences/{id}/process | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes"{success} Response 200 (application/json)
Quando a constante for aplicada às constantes de dispositivo.
[
"Foi solicitado o processamento da análise de constantes."
]{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
{warning} Response 404 (application/json)
Quando a análise solicitada não existir ou estiver deletada.
[
"Registro inexistente para este dispositivo ou permissões suficientes."
]{warning} Response 422 (application/json)
Quando a análise solicitada já estiver concluída.
[
"A análise de constantes específicada já está concluída."
]Endpoint que processa uma análise de constantes para um equipamento.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences/process-equipment | Content-Type:application/json | Authorization: Bearer {token} |
equipment_id: 1 (integer, required) - 'Id do equipamento'
initial_date: '2025-01-01' (string) - 'Data de inicio da Analise'{success} Response 200 (application/json)
Quando a constante for aplicada às constantes de dispositivo.
[
"Foi solicitado o processamento da análise de constantes."
]{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
[
"Registro inexistente para este dispositivo ou permissões suficientes."
]{warning} Response 422 (application/json)
{
"equipment_id": [
"Não existe dispositivo relacionando no equipamento informado."
]
}Endpoint que exporta dados de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences/download | Content-Type:application/json | Authorization: Bearer {token} |
initial_date: "2025-01-01" (string) - "Data inicial do período da ocorrência de autocorreção de constantes",
device_id: 1 (integer) - "ID do dispositivo associado à ocorrência de autocorreção de constantes",
equipment_id: 1 (integer) - "ID do equipamento associado à ocorrência de autocorreção de constantes",
closed: 1 (boolean) - "Indica se deve reprocessar as medições com o valor da nova constante aplicada"{success} Response 200 (application/json)
Quando a solicitação de exportação de dados for solicitada com sucesso.
{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
{warning} Response 404 (application/json)
Quando não existir registros a serem retornados nos moldes específicados.
Endpoint para listar configurações de niveis na analise de ocorrências.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/constant-occurrences-configuration | Content-Type:application/json | Authorization: Bearer {token} |
{success} Response 200 (application/json)
Quando a solicitação de exportação de dados for solicitada com sucesso.
{
"items": [
{
"id": 1,
"level_1_limit": 0.03,
"level_2_limit": 0.06,
"level_1_auto": 0,
"level_2_auto": 0
}
],
"total": 1,
"per_page": 10,
"current_page": 1
}{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
{warning} Response 404 (application/json)
Quando não existir registros a serem retornados nos moldes específicados.
Endpoint para atualizar configurações de niveis na analise de ocorrências.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| PUT | /api/v3/constant-occurrences-configuration/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id da ocorrência de autocorreção de constantes""level_1_limit: (float) 0.03 - Limite de desvio do nível 1",
"level_2_limit: (float) 0.06 - Limite de desvio de nível 2",
"level_1_auto: (bool) 0 - Flag para indicar se nivel 1 deve ser aplicado automaticamente",
"level_2_auto: (bool) 0 - Flag para indicar se nivel 2 deve ser aplicado automaticamente",{success} Response 200 (application/json)
Quando a solicitação de exportação de dados for solicitada com sucesso.
{
"id": 1,
"level_1_limit": 0.03,
"level_2_limit": 0.06,
"level_1_auto": 0,
"level_2_auto": 0
}{warning} Response 401 (application/json)
Quando o usuário não tiver permissão.
{warning} Response 404 (application/json)
Quando não existir registros a serem retornados nos moldes específicados.
Endpoint para listar consumo para simulação de autocorreção de constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/constant-occurrences-simulation/ | Content-Type:application/json | Authorization: Bearer {token} |
measurement_id: 31 (integer, required) - "Id da Medição",
initial_date: "2025-10-01" (string, required) - "Data Inicial do período da simulação",
final_date: "2025-10-31" (string, required) - "Data Final do período da simulação",{success} Response 200 (application/json)
Quando os dados foram solicitados com sucesso.
{
"series": [
{
"hourly_frequency": 4,
"constant_suggested": 0.2,
"data": [
{
"timestamp": 1759287600,
"value": 0.05437499999999999,
"constant": 10
},
{
"timestamp": 1759291200,
"value": 0.10855,
"constant": 10
}
]
}
]
}{warning} Response 403 (application/json)
Quando o usuário não tiver permissão.