Map_Object
Seitenverzeichnis:
shd.map_object.create
Beschreibung
Erstellen eines Map-Objekts.
Parameter
Parameter | Typ | Version |
---|---|---|
user_id (optional) | string | ab Version 1.0 |
shd_map__id | string | ab Version 1.0 |
isys_obj__id | string | ab Version 1.0 |
position | string | ab Version 1.0 |
width | string | ab Version 1.0 |
title | string | ab Version 1.0 |
is_title_custom | string | ab Version 1.0 |
labelposition | string | ab Version 1.0 |
imagepath | string | ab Version 1.0 |
livestatus_profile | string | ab Version 1.0 |
livestatus_services | array | ab Version 1.0 |
livestatus_color | string | ab Version 1.0 |
is_imagepath_custom | string | ab Version 1.0 |
layerindex | string | ab Version 1.0 |
textvisible | string | ab Version 1.0 |
iconvisible | string | ab Version 1.0 |
link | string | ab Version 1.0 |
realizertype | string | ab Version 1.0 |
shapetype | string | ab Version 1.0 |
fillcolor | string | ab Version 1.0 |
fillcolor2 | string | ab Version 1.0 |
iscolorgradient | string | ab Version 1.0 |
linecolor | string | ab Version 1.0 |
labellinecolor | string | ab Version 1.0 |
textcolor | string | ab Version 1.0 |
font | string | ab Version 1.0 |
textalignment | string | ab Version 1.0 |
locked | string | ab Version 1.0 |
cat_const | string | ab Version 1.0 |
property_key | string | ab Version 1.0 |
shd_insight__id | int | ab Version 1.0 |
layout | string | ab Version 1.0 |
layout_configuration | string/json | ab Version 1.0 |
cable_position | string | ab Version 1.0 |
cable_orientation | string | ab Build 2120 |
Rückgabewert
Wert | Typ | Beschreibung | Version |
---|---|---|---|
message | string | "map_object.update.success" | ab Version 1.0 |
response | string | ID des Map-Objekts | ab Version 1.0 |
current_date | string | - | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object.create", "params": { "apikey": "24174j3tqj", "user_id": "19", "shd_map__id": "2", "isys_obj__id": "1", "position": "12;140", "width": "50", "height": "50", "title": "Überschrift", "livestatus_services": [ "smbox_Backup_Age", "smbox_Current_Load", "smbox_Disk_Space", "smbox_Processes_Total" ], "labelposition": "75", "imagepath": "", "layerindex": "999", "textvisible": "0", "iconvisible": "1", "link": "maps/220/IDE.map", "realizertype": "6", "shapetype": "9", "fillcolor": "#ff1100", "fillcolor2": "#ff1100", "iscolorgradient": "1", "linecolor": "#ff1100", "labellinecolor": "#ff1100", "textcolor": "#ff1100", "font": "Sans Serif", "textalignment": "1", "locked": "false", "cat_const": "C__CATG__GLOABL", "property_key": "description", "shd_insight__id": 4, "layout": "ORTHOGONAL", "layout_configuration": "{port: {port_layout: 'PORT_LAYOUT_FREE', ...}}", "cable_position": "xy", "cable_orientation": "N", "debug": true, "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc": "2.0", "result": { "message": "map_object.update.success", "response": "5", "current_date": "2017-08-08" }, "id": 1 } |
shd.map_object.read
Beschreibung
Auslesen eines Map-Objektes.
Parameter
Parameter | Typ | Version |
---|---|---|
mapobject_id | string | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
mapobject_id | string | ab Version 1.0 |
shd_map__id | string | ab Version 1.0 |
isys_obj__id | string | ab Version 1.0 |
position | string | ab Version 1.0 |
width | string | ab Version 1.0 |
title | string | ab Version 1.0 |
is_title_custom | string | ab Version 1.0 |
labelposition | string | ab Version 1.0 |
imagepath | string | ab Version 1.0 |
livestatus_profile | string | ab Version 1.0 |
livestatus_services | array | ab Version 1.0 |
livestatus_color | string | ab Version 1.0 |
is_imagepath_custom | string | ab Version 1.0 |
layerindex | string | ab Version 1.0 |
textvisible | string | ab Version 1.0 |
iconvisible | string | ab Version 1.0 |
link | string | ab Version 1.0 |
realizertype | string | ab Version 1.0 |
shapetype | string | ab Version 1.0 |
fillcolor | string | ab Version 1.0 |
fillcolor2 | string | ab Version 1.0 |
iscolorgradient | string | ab Version 1.0 |
linecolor | string | ab Version 1.0 |
labellinecolor | string | ab Version 1.0 |
textcolor | string | ab Version 1.0 |
font | string | ab Version 1.0 |
textalignment | string | ab Version 1.0 |
locked | string | ab Version 1.0 |
cat_const | string | ab Version 1.0 |
property_key | string | ab Version 1.0 |
type | string | ab Version 1.0 |
shd_insight__id | int | ab Version 1.0 |
layout | string | ab Version 1.0 |
layout_configuration | string/json | ab Version 1.0 |
cable_position | string | ab Version 1.0 |
cable_orientation | string | ab Build 2120 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object", "params": { "apikey": "24174j3tqj", "mapobject_id": "1", "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc": "2.0", "result": { "mapobject_id": "1", "shd_map__id": "2", "isys_obj__id": "1", "position": "99;99", "width": "50", "height": "50", "title": "Überschrift Grpß", "title_original": "Überschrift Grpß", "labelposition": "75", "imagepath": "", "imagepath_original": "", "layerindex": "999", "textvisible": "0", "iconvisible": "1", "link": "", "realizertype": "6", "shapetype": "9", "fillcolor": "#ff1100", "fillcolor2": "#ff1100", "iscolorgradient": "1", "linecolor": "#ff1100", "labellinecolor": "#ff1100", "textcolor": "#ff1100", "font": "Sans Serif", "textalignment": "1", "locked": "0", "cat_const": "C__CATG__GLOABL", "property_key": "description", "type": "image_node", "shd_insight__id": 4, "layout": "ORTHOGONAL", "layout_configuration": "{port: {port_layout: 'PORT_LAYOUT_FREE', ...}}", "cable_position": "xy", "cable_orientation": "N" }, "id": 1 } |
shd.map_object.update
Beschreibung
Bearbeiten eines Map-Objektes.
Parameter
Parameter | Typ | Version |
---|---|---|
mapobject_id | string | ab Version 1.0 |
shd_map__id | string | ab Version 1.0 |
isys_obj__id (optional) | string | ab Version 1.0 |
position (optional) | string | ab Version 1.0 |
width (optional) | string | ab Version 1.0 |
title (optional) | string | ab Version 1.0 |
is_title_custom (optional) | string | ab Version 1.0 |
labelposition (optional) | string | ab Version 1.0 |
imagepath (optional) | string | ab Version 1.0 |
livestatus_profile (optional) | string | ab Version 1.0 |
livestatus_services (optional) | array | ab Version 1.0 |
livestatus_color (optional) | string | ab Version 1.0 |
is_imagepath_custom (optional) | string | ab Version 1.0 |
layerindex (optional) | string | ab Version 1.0 |
textvisible (optional) | string | ab Version 1.0 |
iconvisible (optional) | string | ab Version 1.0 |
link (optional) | string | ab Version 1.0 |
realizertype (optional) | string | ab Version 1.0 |
shapetype (optional) | string | ab Version 1.0 |
fillcolor (optional) | string | ab Version 1.0 |
fillcolor2 (optional) | string | ab Version 1.0 |
iscolorgradient (optional) | string | ab Version 1.0 |
linecolor (optional) | string | ab Version 1.0 |
labellinecolor (optional) | string | ab Version 1.0 |
textcolor (optional) | string | ab Version 1.0 |
font (optional) | string | ab Version 1.0 |
textalignment (optional) | string | ab Version 1.0 |
locked (optional) | string | ab Version 1.0 |
cat_const (optional) | string | ab Version 1.0 |
property_key (optional) | string | ab Version 1.0 |
shd_insight__id (optional) | int | ab Version 1.0 |
layout (optional) | string | ab Version 1.0 |
layout_configuration (optional) | string/json | ab Version 1.0 |
cable_position (optional) | string | ab Version 1.0 |
cable_orientation (optional) | string | ab Build 2120 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
message | string | ab Version 1.0 |
response | bool | ab Version 1.0 |
current_date | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object.update", "params": { "apikey": "itp431", "mapobject_id": "1", "user_id": "19", "shd_map__id": "2", "isys_obj__id": "1", "position": "99;99", "width": "50", "height": "50", "title": "Überschrift Grpß", "labelposition": "75", "imagepath": "", "layerindex": "999", "textvisible": "0", "iconvisible": "1", "link": "maps/220/IDE.map", "realizertype": "6", "shapetype": "9", "fillcolor": "#ff1100", "fillcolor2": "#ff1100", "iscolorgradient": "1", "linecolor": "#ff1100", "labellinecolor": "#ff1100", "textcolor": "#ff1100", "font": "Sans Serif", "textalignment": "1", "locked": "false", "cat_const": "C__CATG__GLOABL", "property_key": "description", "shd_insight__id": 8, "layout": "ORTHOGONAL", "layout_configuration": "{port: {port_layout: 'PORT_LAYOUT_FREE', ...}}", "cable_position": "xy", "cable_orientation": "N", "debug": true, "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc":"2.0", "result":{ "message":"map_object.update.success", "response":true, "current_date":"2017-08-08" }, "id":1 } |
shd.map_object.delete
Beschreibung
Löschen eines Map-Objektes.
Parameter
Parameter | Typ | Version |
---|---|---|
mapobject_id | string | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
message | string | ab Version 1.0 |
response | bool | ab Version 1.0 |
current_date | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object.delete", "params": { "apikey": "23phgjrfpv", "mapobject_id": "3", "debug": true, "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc":"2.0", "result":{ "message":"map_object.delete.success", "response":true, "current_date":"2017-08-08" }, "id":1 } |
shd.map_object.updateLayerIndex
Beschreibung
Klonen einer Map.
Parameter
Parameter | Typ | Version |
---|---|---|
map_id | string | ab Version 1.0 |
index | string | ab Version 1.0 |
mapobject_id | string | ab Version 1.0 |
Rückgabewert
Wert | Typ | Beschreibung | Version |
---|---|---|---|
message | string | - | ab Version 1.0 |
response | string | ID der Map | ab Version 1.0 |
current_date | string | - | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object.updateLayerIndex", "params": { "apikey": "1ialbgclm9", "map_id": "3", "mapobject_id": "110", "index": "4", "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc": "2.0", "result": { "message": "map_object.updateLayerIndex.success", "response": true, "current_date": "2017-10-25" }, "id": 1 } |
shd.map_object.status
Beschreibung
Auslesen des Status eines Map-Objekts.
Parameter
Parameter | Typ | Version |
---|---|---|
mapobject_id | string | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
status | string | ab Version 1.0 |
output | string | ab Version 1.0 |
text | string | ab Version 1.0 |
color | string | ab Version 1.0 |
services | array | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
---|---|
{ "method": "shd.map_object.status", "params": { "apikey": "24174j3tqj", "mapobject_id": "46", "language": "en" }, "id": 1, "version": "2.0" } | { "jsonrpc":"2.0", "result":{ "status":2, "output":"Backup device not mounted", "text":"DOWN", "color":"#E7A1A2", "services":[ { "host_name":"box2", "description":"smbox_Backup_Age", "display_name":"smbox_Backup_Age", "check_command":"shdSmbox_backupAge_shell", "check_interval":5, "max_check_attempts":3, "retry_interval":1, "last_check":1547554511, "last_hard_state":2, "last_state":2, "plugin_output":"Backup device not mounted", "perf_data":"", "state":2, "state_type":1 } ] }, "id":1 } |
(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/