Объект карты

Следующие объекты напрямую связаны с API map.

Карта

Объект карты имеет следующие свойства.

Свойство Тип Описание
sysmapid ID ID карты.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
height integer Высота карты в пикселях.

Поведение свойства:
- обязательно для операций создания
name string Имя карты.

Поведение свойства:
- обязательно для операций создания
width integer Ширина карты в пикселях.

Поведение свойства:
- обязательно для операций создания
backgroundid ID ID изображения, используемого в качестве фона карты.
background_scale integer Следует ли включить пропорциональное масштабирование фонового изображения.

Возможные значения:
0 - отключить масштабирование;
1 - (по умолчанию) включить масштабирование изображения.
expand_macros integer Следует ли раскрывать макросы в метках при настройке карты.

Возможные значения:
0 - (по умолчанию) не раскрывать макросы;
1 - раскрывать макросы.
expandproblem integer Следует ли отображать проблемный триггер для элементов с одной проблемой.

Возможные значения:
0 - всегда отображать количество проблем;
1 - (по умолчанию) отображать проблемный триггер, если проблема только одна.
grid_align integer Следует ли включить выравнивание по сетке.

Возможные значения:
0 - отключить выравнивание по сетке;
1 - (по умолчанию) включить выравнивание по сетке.
grid_show integer Следует ли показывать сетку на карте.

Возможные значения:
0 - не показывать сетку;
1 - (по умолчанию) показывать сетку.
grid_size integer Размер сетки карты в пикселях.

Поддерживаемые значения: 20, 40, 50, 75 и 100.

По умолчанию: 50.
highlight integer Включена ли подсветка иконок.

Возможные значения:
0 - подсветка отключена;
1 - (по умолчанию) подсветка включена.
iconmapid ID ID карты иконок, используемой на карте.
label_format integer Следует ли включить расширенные метки.

Возможные значения:
0 - (по умолчанию) отключить расширенные метки;
1 - включить расширенные метки.
label_location integer Расположение метки элемента карты.

Возможные значения:
0 - (по умолчанию) снизу;
1 - слева;
2 - справа;
3 - сверху.
label_string_host string Пользовательская метка для элементов узла сети.

Поведение свойства:
- обязательно, если label_type_host установлено в "custom"
label_string_hostgroup string Пользовательская метка для элементов группы узлов сети.

Поведение свойства:
- обязательно, если label_type_hostgroup установлено в "custom"
label_string_image string Пользовательская метка для элементов изображения.

Поведение свойства:
- обязательно, если label_type_image установлено в "custom"
label_string_map string Пользовательская метка для элементов карты.

Поведение свойства:
- обязательно, если label_type_map установлено в "custom"
label_string_trigger string Пользовательская метка для элементов триггера.

Поведение свойства:
- обязательно, если label_type_trigger установлено в "custom"
label_type integer Тип метки элемента карты.

Возможные значения:
0 - метка;
1 - IP-адрес;
2 - (по умолчанию) имя элемента;
3 - только состояние;
4 - ничего.
label_type_host integer Тип метки для элементов узла сети.

Возможные значения:
0 - метка;
1 - IP-адрес;
2 - (по умолчанию) имя элемента;
3 - только состояние;
4 - ничего;
5 - пользовательская.
label_type_hostgroup integer Тип метки для элементов группы узлов сети.

Возможные значения:
0 - метка;
2 - (по умолчанию) имя элемента;
3 - только состояние;
4 - ничего;
5 - пользовательская.
label_type_image integer Тип метки для элементов группы узлов сети.

Возможные значения:
0 - метка;
2 - (по умолчанию) имя элемента;
4 - ничего;
5 - пользовательская.
label_type_map integer Тип метки для элементов карты.

Возможные значения:
0 - метка;
2 - (по умолчанию) имя элемента;
3 - только состояние;
4 - ничего;
5 - пользовательская.
label_type_trigger integer Тип метки для элементов триггера.

Возможные значения:
0 - метка;
2 - (по умолчанию) имя элемента;
3 - только состояние;
4 - ничего;
5 - пользовательская.
markelements integer Следует ли подсвечивать элементы карты, у которых недавно изменилось состояние.

Возможные значения:
0 - (по умолчанию) не подсвечивать элементы;
1 - подсвечивать элементы.
severity_min integer Минимальная важность триггеров, которые будут отображаться на карте.

Список поддерживаемых уровней важности триггеров см. в свойстве триггера severity.
show_element_label integer Как отображать метки элементов по умолчанию.

Возможные значения:
0 - всегда отображать;
1 - (по умолчанию) автоматически скрывать.
show_link_label integer Как отображать метки связей по умолчанию.

Возможные значения:
0 - всегда отображать;
1 - (по умолчанию) автоматически скрывать.
show_unack integer Как должны отображаться проблемы.

Возможные значения:
0 - (по умолчанию) отображать количество всех проблем;
1 - отображать только количество неподтвержденных проблем;
2 - отображать количество подтвержденных и неподтвержденных проблем отдельно.
userid ID ID пользователя, являющегося владельцем карты.
private integer Тип общего доступа к карте.

Возможные значения:
0 - общедоступная карта;
1 - (по умолчанию) приватная карта.
show_suppressed integer Следует ли показывать подавленные проблемы.

Возможные значения:
0 - (по умолчанию) скрывать подавленные проблемы;
1 - показывать подавленные проблемы.

Элемент карты

Объект элемента карты определяет объект, отображаемый на карте. Он имеет следующие свойства.

Свойство Тип Описание
selementid ID ID элемента карты.

Поведение свойства:
- только для чтения
elements array Объект данных элемента.

Поведение свойства:
- обязательно, если elementtype установлено в "host", "map", "trigger" или "host group"
elementtype integer Тип элемента карты.

Возможные значения:
0 - узел сети;
1 - карта;
2 - триггер;
3 - группа узлов сети;
4 - изображение.

Поведение свойства:
- обязательно
iconid_off ID ID изображения, используемого для отображения элемента в состоянии по умолчанию.

Поведение свойства:
- обязательно
areatype integer Как должны отображаться отдельные узлы сети группы узлов сети.

Возможные значения:
0 - (по умолчанию) элемент группы узлов сети будет занимать всю карту;
1 - элемент группы узлов сети будет иметь фиксированный размер.
elementsubtype integer Как элемент группы узлов сети должен отображаться на карте.

Возможные значения:
0 - (по умолчанию) отображать группу узлов сети как один элемент;
1 - отображать каждый узел сети в группе отдельно.
evaltype integer Условие фильтрации тегов элемента карты, метод вычисления.

Возможные значения:
0 - (по умолчанию) И/Или;
2 - Или.
height integer Высота элемента группы узлов сети фиксированного размера в пикселях.

По умолчанию: 200.
iconid_disabled ID ID изображения, используемого для отображения отключенных элементов карты.

Поведение свойства:
- поддерживается, если elementtype установлено в "host", "map", "trigger" или "host group"
iconid_maintenance ID ID изображения, используемого для отображения элементов карты в обслуживании.

Поведение свойства:
- поддерживается, если elementtype установлено в "host", "map", "trigger" или "host group"
iconid_on ID ID изображения, используемого для отображения элементов карты с проблемами.

Поведение свойства:
- поддерживается, если elementtype установлено в "host", "map", "trigger" или "host group"
label string Метка элемента.
label_location integer Расположение метки элемента карты.

Возможные значения:
-1 - (по умолчанию) расположение по умолчанию;
0 - снизу;
1 - слева;
2 - справа;
3 - сверху.
permission integer Тип уровня доступа.

Возможные значения:
-1 - нет;
2 - только чтение;
3 - чтение-запись.
show_label integer Как отображать метку элемента.

Возможные значения:
-1 - (по умолчанию) значение карты по умолчанию;
0 - отображать всегда;
1 - автоматически скрывать.
sysmapid ID ID карты, к которой принадлежит элемент.

Поведение свойства:
- только для чтения
urls array URL-адреса элемента карты.

Объект URL элемента карты подробно описан ниже.
use_iconmap integer Следует ли использовать сопоставление иконок для элементов узлов сети.

Возможные значения:
0 - не использовать сопоставление иконок;
1 - (по умолчанию) использовать сопоставление иконок.
viewtype integer Алгоритм размещения элемента группы узлов сети.

Возможные значения:
0 - (по умолчанию) сетка.
width integer Ширина элемента группы узлов сети фиксированного размера в пикселях.

По умолчанию: 200.
x integer Координата X элемента в пикселях.

По умолчанию: 0.
y integer Координата Y элемента в пикселях.

По умолчанию: 0.
zindex integer Значение, используемое для упорядочивания элементов карты (z-index).

По умолчанию: 0.

Элемент карты «Узел сети»

Объект элемента карты Host определяет один элемент узла сети.

Свойство Type Описание
hostid ID ID узла сети.

Элемент карты «Группа узлов сети»

Объект элемента карты Host group определяет один элемент группы узлов сети.

Свойство Type Описание
groupid ID ID группы узлов сети.

Элемент карты Map

Объект элемента карты Map определяет один элемент карты.

Свойство Тип Описание
sysmapid ID ID карты.

Элемент карты Trigger

Объект элемента карты Trigger определяет один или несколько элементов триггера.

Свойство Type Описание
triggerid ID ID триггера.

Тег элемента карты

Объект тега элемента карты имеет следующие свойства.

Свойство Тип Описание
tag string Имя тега элемента карты.

Поведение свойства:
- обязательно
operator integer Условие оператора тега элемента карты.

Возможные значения:
0 - (по умолчанию) Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.
value string Значение тега элемента карты.

URL элемента карты

Объект URL элемента карты определяет кликабельную ссылку, которая будет доступна для определенного элемента карты. Он имеет следующие свойства:

Свойство Тип Описание
sysmapelementurlid ID ID URL элемента карты.

Поведение свойства:
- только для чтения
name string Подпись ссылки.

Поведение свойства:
- обязательно
url string URL ссылки.

Поведение свойства:
- обязательно
selementid ID ID элемента карты, к которому относится URL.

Ссылка карты

Объект ссылки карты определяет связь между двумя элементами карты. Он имеет следующие свойства.

Свойство Тип Описание
linkid ID ID ссылки карты.

Поведение свойства:
- только для чтения
sysmapid ID ID карты, к которой принадлежит ссылка.
selementid1 ID ID первого элемента карты, связанного с одной стороны.

Поведение свойства:
- обязательно
selementid2 ID ID первого элемента карты, связанного с другой стороны.

Поведение свойства:
- обязательно
drawtype integer Стиль отрисовки линии ссылки.

Возможные значения:
0 - (по умолчанию) линия;
2 - жирная линия;
3 - точечная линия;
4 - пунктирная линия.
color string Цвет линии в виде шестнадцатеричного кода цвета.

По умолчанию: 000000.
label string Метка ссылки.
show_label integer Как отображать метку ссылки.

Возможные значения:
-1 - (по умолчанию) значение карты по умолчанию;
0 - отображать всегда;
1 - скрывать автоматически.
indicator_type integer Выберите тип индикатора ссылки.

Возможные значения:
0 - (по умолчанию) статическая ссылка;
1 - триггер;
2 - значение элемента данных.
linktriggers array Триггеры ссылки карты, используемые как индикаторы состояния ссылки.

Объект триггера ссылки карты подробно описан ниже.

Поведение свойства:
- обязательно, если indicator_type установлено в "trigger" (1).
itemid ID ID элемента данных.

Поведение свойства:
- обязательно, если indicator_type установлено в "item value" (2).
highlights array Подсветки ссылки карты, используемые как индикаторы состояния ссылки.

Объект индикаторов ссылки карты подробно описан ниже.

Поведение свойства:
- обязательно, если indicator_type установлено в "item value" (2).
thresholds array Пороговые значения ссылки карты, используемые как индикаторы состояния ссылки.

Объект индикаторов ссылки карты подробно описан ниже.

Поведение свойства:
- обязательно, если indicator_type установлено в "item value" (2).
permission integer Тип уровня прав доступа.

Возможные значения:
-1 - нет;
2 - только чтение;
3 - чтение-запись.

Триггер ссылки карты

Объект триггера ссылки карты определяет индикатор состояния ссылки карты на основе состояния триггера. Он имеет следующие свойства:

Свойство Type Описание
triggerid ID ID триггера, используемого в качестве индикатора ссылки.

Поведение свойства:
- обязательно
color string Цвет индикатора в виде шестнадцатеричного кода цвета.

По умолчанию: DD0000.
drawtype integer Стиль отрисовки индикатора.

Возможные значения:
0 - (по умолчанию) линия;
2 - жирная линия;
3 - пунктирная линия;
4 - штриховая линия.

Индикаторы ссылок карты

Объект индикаторов ссылок карты определяет индикатор состояния ссылки карты на основе значения элемента данных. Он имеет следующие свойства:

Свойство Type Описание
pattern string Регулярное выражение для сравнения. Доступно только для выделений.
sortorder integer Используется для определения порядка сортировки выделений. Доступно только для выделений.
threshold string Числовое значение для сравнения. Доступно только для порогов.
drawtype integer Стиль отрисовки индикатора.

Возможные значения:
0 - (по умолчанию) линия;
2 - жирная линия;
3 - пунктирная линия;
4 - штриховая линия.
color string Цвет индикатора в виде шестнадцатеричного кода цвета.

По умолчанию: DD0000.

Поведение свойства:
- обязательно

URL карты

Объект URL карты определяет кликабельную ссылку, которая будет доступна для всех элементов определённого типа на карте. Он имеет следующие свойства:

Свойство Type Описание
sysmapurlid ID ID URL карты.

Property behavior:
- read-only
name string Подпись ссылки.

Property behavior:
- required
url string URL ссылки.

Property behavior:
- required
elementtype integer Тип элемента карты, для которого URL будет доступен.

Список поддерживаемых типов см. в свойстве type элемента карты.

По умолчанию: 0.
sysmapid ID ID карты, к которой относится URL.

Пользователь карты

Список разрешений карты на основе пользователей. Имеет следующие свойства:

Свойство Type Описание
sysmapuserid ID ID пользователя карты.

Поведение свойства:
- только для чтения
userid ID ID пользователя.

Поведение свойства:
- обязательно
permission integer Тип уровня разрешений.

Возможные значения:
2 - только чтение;
3 - чтение-запись.

Поведение свойства:
- обязательно

Группа пользователей карты

Список разрешений карты на основе групп пользователей. Имеет следующие свойства:

Свойство Type Описание
sysmapusrgrpid ID ID группы пользователей карты.

Property behavior:
- только для чтения
usrgrpid ID ID группы пользователей.

Property behavior:
- обязательно
permission integer Тип уровня разрешений.

Возможные значения:
2 - только чтение;
3 - чтение-запись.

Property behavior:
- обязательно

Фигуры карты

Объект фигуры карты определяет геометрическую фигуру (с текстом или без него), отображаемую на карте. Он имеет следующие свойства:

Свойство Тип Описание
sysmap_shapeid ID ID элемента фигуры карты.

Поведение свойства:
- только для чтения
type integer Тип элемента фигуры карты.

Возможные значения:
0 - прямоугольник;
1 - эллипс.

Свойство является обязательным при создании новых фигур.

Поведение свойства:
- обязательно
x integer X-координаты фигуры в пикселях.

По умолчанию: 0.
y integer Y-координаты фигуры в пикселях.

По умолчанию: 0.
width integer Ширина фигуры в пикселях.

По умолчанию: 200.
height integer Высота фигуры в пикселях.

По умолчанию: 200.
text string Текст фигуры.
font integer Шрифт текста внутри фигуры.

Возможные значения:
0 - Georgia, serif
1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif
2 - “Times New Roman”, Times, serif
3 - Arial, Helvetica, sans-serif
4 - “Arial Black”, Gadget, sans-serif
5 - “Comic Sans MS”, cursive, sans-serif
6 - Impact, Charcoal, sans-serif
7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif
8 - Tahoma, Geneva, sans-serif
9 - “Trebuchet MS”, Helvetica, sans-serif
10 - Verdana, Geneva, sans-serif
11 - “Courier New”, Courier, monospace
12 - “Lucida Console”, Monaco, monospace

По умолчанию: 9.
font_size integer Размер шрифта в пикселях.

По умолчанию: 11.
font_color string Цвет шрифта.

По умолчанию: 000000.
text_halign integer Горизонтальное выравнивание текста.

Возможные значения:
0 - по центру;
1 - слева;
2 - справа.

По умолчанию: 0.
text_valign integer Вертикальное выравнивание текста.

Возможные значения:
0 - по середине;
1 - сверху;
2 - снизу.

По умолчанию: 0.
border_type integer Тип границы.

Возможные значения:
0 - нет;
1 - —————;
2 - ·····;
3 - - - -.

По умолчанию: 0.
border_width integer Ширина границы в пикселях.

По умолчанию: 0.
border_color string Цвет границы.

По умолчанию: 000000.
background_color string Цвет фона (цвет заливки).

По умолчанию: (пусто).
zindex integer Значение, используемое для упорядочивания всех фигур и линий (z-index).

По умолчанию: 0.

Линии карты

Объект линии карты определяет линию, отображаемую на карте. Он имеет следующие свойства:

Свойство Тип Описание
sysmap_shapeid ID ID элемента фигуры карты.

Поведение свойства:
- только для чтения
x1 integer X-координаты точки 1 линии в пикселях.

По умолчанию: 0.
y1 integer Y-координаты точки 1 линии в пикселях.

По умолчанию: 0.
x2 integer X-координаты точки 2 линии в пикселях.

По умолчанию: 200.
y2 integer Y-координаты точки 2 линии в пикселях.

По умолчанию: 200.
line_type integer Тип линий.

Возможные значения:
0 - нет;
1 - —————;
2 - ·····;
3 - - - -.

По умолчанию: 0.
line_width integer Ширина линий в пикселях.

По умолчанию: 0.
line_color string Цвет линии.

По умолчанию: 000000.
zindex integer Значение, используемое для упорядочивания всех фигур и линий (z-index).

По умолчанию: 0.