update_events
Чтобы отметить заправку или слив топлива как ложное событие либо снять такую отметку, используйте метод unit/update_events.
События, отмеченные как ложные, показываются в отчетах только при включенной опции Показывать ложные события в настройках шаблона отчета.
Конечная точка
svc=unit/update_events¶ms={
"events": [
{
"itemId": <long>,
"resourceId": <long>,
"eventType": <text>,
"timeFrom": <uint>,
"timeTo": <uint>,
"params": {
"mark": <uint>,
"mark_type": <text>
}
}
]
}
Параметры
Запрос должен содержать следующие параметры:
| Параметр | Описание |
|---|---|
| events | Массив событий, для которых необходимо поставить или снять метку ложного события. |
| itemId | ID объекта. |
| resourceId | ID ресурса, в котором хранится выполненный отчет. |
| eventType | Тип события: lls (уровень топлива), theft (слив топлива), filling (заправка топлива). |
| timeFrom | Начало события, UNIX-время. |
| timeTo | Окончание события, UNIX-время. |
| params | Объект с обновляемыми параметрами. |
| mark | Отметка ложного события: 1 — отметить событие как ложное, 0 — снять отметку. |
| mark_type | Подтип события для отметки: fillings (заправка топлива) или thefts (слив топлива). Обязателен, если eventType — lls. |
Заправка и слив топлива могут быть зарегистрированы в один и тот же промежуток времени. Используйте
mark_type, чтобы указать, какое из событий отметить как ложное. Без этого параметра отметка применяется к обоим событиям.
Возвращаемый результат
При успешном выполнении запроса возвращается ответ в следующем формате:
{
"items": [
{
"itemId": <long>, /* ID объекта. */
"error": <uint>, /* Результат для события: 0, если отметка обновлена, 7, если нет права доступа. */
"msgs": <uint> /* Количество обновленных сообщений. */
}
]
}
Массив items содержит один объект для каждого события из запроса, в том же порядке.
В противном случае возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 5 | События отключены для объекта. |
| 7 | Нет права доступа Создание, редактирование и удаление шаблонов отчетов на ресурс либо нет права доступа Просмотр элемента и его основных свойств на объект. |
Пример
Чтобы отметить два события заправки топлива объекта с ID 1285 как ложные, используется следующий запрос. Параметр mark_type указан как fillings, чтобы отметить только заправки, а не сливы топлива, зарегистрированные в то же время:
svc=unit/update_events¶ms={
"events": [
{
"itemId": 1285,
"resourceId": 123,
"eventType": "lls",
"timeFrom": 1689734883,
"timeTo": 1689734883,
"params": {
"mark": 1,
"mark_type": "fillings"
}
},
{
"itemId": 1285,
"resourceId": 123,
"eventType": "lls",
"timeFrom": 1689737145,
"timeTo": 1689737145,
"params": {
"mark": 1,
"mark_type": "fillings"
}
}
]
}
Ответ содержит один объект для каждого события из запроса. В этом примере error: 0 для обоих событий означает, что отметка ложного события успешно обновлена, а msgs: 1 означает, что для каждого события обновлено одно сообщение:
{
"items": [
{
"itemId": 1285,
"error": 0,
"msgs": 1
},
{
"itemId": 1285,
"error": 0,
"msgs": 1
}
]
}