Map_Object

Seitenverzeichnis: 



shd.map_object.create

Beschreibung

Erstellen eines Map-Objekts.

Parameter

ParameterTypVersion
user_id (optional)stringab Version 1.0
shd_map__idstringab Version 1.0
isys_obj__idstringab Version 1.0
positionstringab Version 1.0
widthstringab Version 1.0
titlestringab Version 1.0
is_title_customstringab Version 1.0
labelpositionstringab Version 1.0
imagepathstringab Version 1.0
livestatus_profilestringab Version 1.0
livestatus_servicesarrayab Version 1.0
livestatus_colorstringab Version 1.0
is_imagepath_customstringab Version 1.0
layerindexstringab Version 1.0
textvisiblestringab Version 1.0
iconvisiblestringab Version 1.0
linkstringab Version 1.0
realizertypestringab Version 1.0
shapetypestringab Version 1.0
fillcolorstringab Version 1.0
fillcolor2stringab Version 1.0
iscolorgradientstringab Version 1.0
linecolorstringab Version 1.0
labellinecolorstringab Version 1.0
textcolorstringab Version 1.0
fontstringab Version 1.0
textalignmentstringab Version 1.0
lockedstringab Version 1.0
cat_conststringab Version 1.0
property_keystringab Version 1.0
shd_insight__idintab Version 1.0
layoutstringab Version 1.0
layout_configurationstring/jsonab Version 1.0
cable_positionstringab Version 1.0
cable_orientationstringab Build 2120

Rückgabewert

WertTypBeschreibungVersion
messagestring"map_object.update.success"ab Version 1.0
responsestringID des Map-Objektsab Version 1.0
current_datestring-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

ParameterTypVersion
mapobject_idstringab Version 1.0

Rückgabewert

WertTypVersion
mapobject_idstringab Version 1.0
shd_map__idstringab Version 1.0
isys_obj__idstringab Version 1.0
positionstringab Version 1.0
widthstringab Version 1.0
titlestringab Version 1.0
is_title_customstringab Version 1.0
labelpositionstringab Version 1.0
imagepathstringab Version 1.0
livestatus_profilestringab Version 1.0
livestatus_servicesarrayab Version 1.0
livestatus_colorstringab Version 1.0
is_imagepath_customstringab Version 1.0
layerindexstringab Version 1.0
textvisiblestringab Version 1.0
iconvisiblestringab Version 1.0
linkstringab Version 1.0
realizertypestringab Version 1.0
shapetypestringab Version 1.0
fillcolorstringab Version 1.0
fillcolor2stringab Version 1.0
iscolorgradientstringab Version 1.0
linecolorstringab Version 1.0
labellinecolorstringab Version 1.0
textcolorstringab Version 1.0
fontstringab Version 1.0
textalignmentstringab Version 1.0
lockedstringab Version 1.0
cat_conststringab Version 1.0
property_keystringab Version 1.0
typestringab Version 1.0
shd_insight__idintab Version 1.0
layoutstringab Version 1.0
layout_configurationstring/jsonab Version 1.0
cable_positionstringab Version 1.0
cable_orientationstringab 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

ParameterTypVersion
mapobject_idstringab Version 1.0
shd_map__idstringab Version 1.0
isys_obj__id (optional)stringab Version 1.0
position (optional)stringab Version 1.0
width (optional)stringab Version 1.0
title (optional)stringab Version 1.0
is_title_custom (optional)stringab Version 1.0
labelposition (optional)stringab Version 1.0
imagepath (optional)stringab Version 1.0
livestatus_profile (optional)stringab Version 1.0
livestatus_services (optional)arrayab Version 1.0
livestatus_color (optional)stringab Version 1.0
is_imagepath_custom (optional)stringab Version 1.0
layerindex (optional)stringab Version 1.0
textvisible (optional)stringab Version 1.0
iconvisible (optional)stringab Version 1.0
link (optional)stringab Version 1.0
realizertype (optional)stringab Version 1.0
shapetype (optional)stringab Version 1.0
fillcolor (optional)stringab Version 1.0
fillcolor2 (optional)stringab Version 1.0
iscolorgradient (optional)stringab Version 1.0
linecolor (optional)stringab Version 1.0
labellinecolor (optional)stringab Version 1.0
textcolor (optional)stringab Version 1.0
font (optional)stringab Version 1.0
textalignment (optional)stringab Version 1.0
locked (optional)stringab Version 1.0
cat_const (optional)stringab Version 1.0
property_key (optional)stringab Version 1.0
shd_insight__id (optional)intab Version 1.0
layout (optional)stringab Version 1.0
layout_configuration (optional)string/jsonab Version 1.0
cable_position (optional)stringab Version 1.0
cable_orientation (optional)stringab Build 2120

Rückgabewert

WertTypVersion
messagestringab Version 1.0
responseboolab Version 1.0
current_datestringab 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

ParameterTypVersion
mapobject_idstringab Version 1.0

Rückgabewert

WertTypVersion
messagestringab Version 1.0
responseboolab Version 1.0
current_datestringab 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

ParameterTypVersion
map_idstringab Version 1.0
indexstringab Version 1.0
mapobject_idstringab Version 1.0

Rückgabewert

WertTypBeschreibungVersion
messagestring-ab Version 1.0
responsestringID der Mapab Version 1.0
current_datestring-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

ParameterTypVersion
mapobject_idstringab Version 1.0

Rückgabewert

WertTypVersion
statusstringab Version 1.0
outputstringab Version 1.0
textstringab Version 1.0
colorstringab Version 1.0
servicesarrayab 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/