Documentation
Table of Contents
> Объект обслуживания
Следующие объекты напрямую связаны с maintenance API.
Обслуживание
Объект обслуживания имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| maintenanceid | строка | (только чтение) ID обслуживания. |
| name (требуется) |
строка | Имя обслуживания. |
| active_since | штамп времени | Время, когда обслуживание становится активным. По умолчанию: текущее время. |
| active_till | штамп времени | Время, когда обслуживание перестает быть активным. По умолчанию: следующий день. |
| description | строка | Описание обслуживания. |
| maintenance_type | целое число | Тип обслуживания. Возможные значения: 0 - (по умолчанию) со сбором данных; 1 - без сбора данных. |
Период времени
Объект периода времени используется для определения периодов времени когда обслуживание должно вступить в силу. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| timeperiodid | строка | (только чтение) ID обслуживания. |
| day | целое число | День месяца, когда обслуживание должно вступить в силу. Требуется только для ежемесячных периодов времени. |
| dayofweek | целое число | Дни недели, когда обслуживание должно вступить в силу. Дни хранятся в бинарном виде, где каждый бит представляет собой соответствующий день. Например, 4 соответствует 100 в бинарном виде и означает, что обслуживание будет активным в Среду. Используется только для ежемесячных и еженедельных периодов времени. Требуется только для еженедельных периодов времени. |
| every | целое число | Для ежедневных и ежемесячных периодов every определяет интервалы дня или недели, в которые обслуживание должно вступить в силу.Для ежемесячных периодов every определяет неделю месяца, когда обслуживание должно вступить в силу.Возможные значения: 1 - первая неделя; 2 - вторая неделя; 3 - третья неделя; 4 - четвертая неделя; 5 - последняя неделя. |
| month | целое число | Месяцы, когда обслуживание должно вступить в силу. Месяцы хранятся в бинарном виде, где каждый бит представляет собой соответствующий месяц. Например, 5 соответствует 101 в бинарном виде и означает, что обслуживание будет активным в Январе и Марте. Требуется только для ежемесячных периодов времени. |
| period | целое число | Длительность периода обслуживания в секундах. По умолчанию: 3600. |
| start_date | штамп времени | Дата, когда период обслуживания должен вступить в силу. Требуется только для единовременных периодов времени. По умолчанию: текущее время. |
| start_time | целое число | Время дня, когда начинается обслуживание, в секундах. Требуется для ежедневных, еженедельных и ежемесячных периодов. |
| timeperiod_type | целое число | Тип периода времени. Возможные значения: 0 - (по умолчанию) единовременно; 2 - ежедневно; 3 - еженедельно; 4 - ежемесячно. |