Объект карты

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

Карта

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

Property Type Description
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 - показывать подавленные проблемы.

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

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

Property Type Description
selementid ID ID элемента карты.

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

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

Возможные значения:
0 - host;
1 - map;
2 - trigger;
3 - host group;
4 - image.

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

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

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

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

Возможные значения:
0 - (по умолчанию) And/Or;
2 - Or.
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 Нужно ли использовать сопоставление значков для элементов host.

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

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

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

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

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

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

Элемент карты узел сети Host

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

Property Type Description
hostid ID ID узла сети.

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

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

Property Type Description
groupid ID ID группы узлов сети.

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

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

Property Type Description
sysmapid ID ID карты.

Объект триггера элемента карты

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

Property Type Description
triggerid ID ID триггера.

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

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

Property Type Description
tag string Имя тега элемента карты.

Поведение свойства:
- required
operator integer Оператор условия тега элемента карты.

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

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

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

Property Type Description
sysmapelementurlid ID ID URL элемента карты.

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

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

Property behavior:
- required
selementid ID ID элемента карты, которому принадлежит URL.

Ссылка карты

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

Property Type Description
linkid ID ID ссылки карты.

Property behavior:
- read-only
sysmapid ID ID карты, к которой принадлежит ссылка.
selementid1 ID ID первого элемента карты, связанного на одном конце.

Property behavior:
- required
selementid2 ID ID первого элемента карты, связанного на другом конце.

Property behavior:
- required
drawtype integer Стиль отображения линии ссылки.

Possible values:
0 - (default) line;
2 - bold line;
3 - dotted line;
4 - dashed line.
color string Цвет линии в виде шестнадцатеричного кода цвета.

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

Possible values:
-1 - (default) map default;
0 - always display;
1 - auto-hide.
indicator_type integer Выберите тип индикатора ссылки.

Possible values:
0 - (default) static link;
1 - trigger;
2 - item value.
linktriggers array Триггеры ссылки карты, используемые в качестве индикаторов состояния ссылки.

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

Property behavior:
- required if indicator_type is set to "trigger" (1).
itemid ID ID элемента данных.

Property behavior:
- required if indicator_type is set to "item value" (2).
highlights array Подсветки ссылки карты, используемые в качестве индикаторов состояния ссылки.

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

Property behavior:
- required if indicator_type is set to "item value" (2).
thresholds array Пороги ссылки карты, используемые в качестве индикаторов состояния ссылки.

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

Property behavior:
- required if indicator_type is set to "item value" (2).
permission integer Тип уровня доступа.

Possible values:
-1 - none;
2 - read only;
3 - read-write.

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

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

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

Property behavior:
- required
color string Цвет индикатора в виде шестнадцатеричного кода цвета.

По умолчанию: DD0000.
drawtype integer Стиль отображения индикатора.

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

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

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

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

Possible values:
0 - (default) line;
2 - bold line;
3 - dotted line;
4 - dashed line.
color string Цвет индикатора в виде шестнадцатеричного кода цвета.

Default: DD0000.

Property behavior:
- required

URL карты

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

Property Type Description
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.

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

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

Property Type Description
sysmapuserid ID ID пользователя карты.

Property behavior:
- read-only
userid ID ID пользователя.

Property behavior:
- required
permission integer Тип уровня доступа.

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

Property behavior:
- required

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

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

Property Type Description
sysmapusrgrpid ID ID группы пользователей карты.

Property behavior:
- read-only
usrgrpid ID ID группы пользователей.

Property behavior:
- required
permission integer Тип уровня доступа.

Possible values:
2 - только чтение;
3 - чтение и запись.

Property behavior:
- required

Фигуры карты

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

Property Type Description
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 Цвет фона (цвет заливки).

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

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

Линии карты

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

Property Type Description
sysmap_shapeid ID ID элемента фигуры карты.

Property behavior:
- read-only
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.