Map

Seitenverzeichnis:

shd.map.create

Beschreibung

Erstellen einer Map.

Parameter

Parameter	Typ	Version
title	string	ab Version 1.0
user_id (optional)	string	ab Version 1.0
provide_screenshot (optional)	int	ab Version 1.0
type (optional)	string	ab Version 1.0
page_size_preview_mode (optional)	int	ab Version 1.0

Rückgabewert

Wert	Typ	Version
map_id	string	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map.create",
    "params": {
        "apikey": "24174j3tqj",
        "user_id": "19",
        "title": "Map Deutschland",
        "provide_screenshot": "1",
		"type": "MAP_DEFAULT_TYPE",
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "message":"map.create.success",
        "response":"5",
        "current_date":"2017-06-24"
    },
    "id":1
}

shd.map.read

Beschreibung

Auslesen einer Map

Parameter

Parameter	Typ	Version
map_id	string	ab Version 1.0

Rückgabewert

Wert	Typ	Version
map_id	string	ab Version 1.0
title	string	ab Version 1.0
map_objects	array	ab Version 1.0
map_connection	array	ab Version 1.0
map_link	array	ab Version 1.0
timestamp	int	ab Version 1.0
layerindex	string	ab Version 1.0
cable_data	array	ab Version 2024.1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "8",
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "map_id":"25",
        "title":"Kopie von Map 123(1)",
        "provide_screenshot": "1",
		"type": "MAP_DEFAULT_TYPE",
        "imagepath":null,
        "monitoring_object_id":null,
        "isys_cats_person_list__id":"19",
        "map_objects":[ 
            { 
                "mapobject_id":"49",
                "shd_map__id":"25",
                "isys_obj__id":"1",
                "position":"99;99",
                "width":"50",
                "height":"50",
                "title":"\u00dcberschrift Grp\u00df",
                "labelposition":"75",
                "imagepath":"",
                "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"
            },
            { 
                "mapobject_id":"50",
                "shd_map__id":"25",
                "isys_obj__id":"1",
                "position":"12;140",
                "width":"50",
                "height":"50",
                "title":"\u00dcberschrift",
                "labelposition":"75",
                "imagepath":"",
                "layerindex":"999",
                "textvisible":"0",
                "iconvisible":"1",
                "link":"1",
                "realizertype":"6",
                "shapetype":"9",
                "fillcolor":"#ff1100",
                "fillcolor2":"#ff1100",
                "iscolorgradient":"1",
                "linecolor":"#ff1100",
                "labellinecolor":"#ff1100",
                "textcolor":"#ff1100",
                "font":"Sans Serif",
                "textalignment":"1",
                "locked":"0"
            }
            [...]
        ],
        "map_link":{ 
            "1":"1",
            "3":"3"
        }
    },
    "id":1
}

shd.map.update

Beschreibung

Bearbeiten einer Map.

Parameter

Parameter	Typ	Version
map_id	string	ab Version 1.0
title	string	ab Version 1.0
user_id (optional)	string	ab Version 1.0
provide_screenshot (optional)	int	ab Version 1.0
type (optional)	string	ab Version 1.0
page_size_preview_mode (optional)	int	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.update",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "3",
        "user_id": "19",
        "title": "Schranketage 3",
        "provide_screenshot": "0",
		"type": "MAP_LOCATION_TYPE",
		"page_size_preview_mode": 1,
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "message":"map.update.success",
        "response":true,
        "current_date":"2017-06-24"
    },
    "id":1
}

shd.map.delete

Beschreibung

Löschen einer Map.

Parameter

Parameter	Typ	Version
map_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.delete",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "9",
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "message":"map.delete.success",
        "response":true,
        "current_date":"2017-07-01"
    },
    "id":1
}

shd.map.duplicate

Beschreibung

Klonen einer Map.

Parameter

Parameter	Typ	Version
map_id	string	ab Version 1.0
map_title (optional)	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.duplicate",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "8",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "message":"map.duplicate.success",
        "response":"23",
        "current_date":"2017-06-25"
    },
    "id":1
}

shd.map.status

Beschreibung

Auslesen des Status einer Map.

Parameter

Parameter	Typ	Version
map_id	string	ab Version 1.0
force_status (optional)	bool	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.status",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "8",
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{
    "jsonrpc": "2.0",
    "result": {
        "objects": {
            "2726": {
                "text": "n/a",
                "status": "-1",
                "output": "",
                "color": "#E6E6E6",
                "service_status": "0|0|0|0"
            },
            "2731": {
                "text": "n/a",
                "status": "-1",
                "output": "",
                "color": "#E6E6E6",
                "service_status": "0|0|0|0"
            },
            "2736": {
                "text": "n/a",
                "status": "-1",
                "output": "",
                "color": "#E6E6E6",
                "service_status": "0|0|0|0"
            }
        },
        "maps": {
            "2": {
                "output": "Remote command execution failed: Could not create directory '/var/lib/nagios/.ssh'.",
                "text": "DOWN",
                "color": "#E7A1A2",
                "status": 2,
                "service_status": "14|0|0|16"
            },
            "3": {
                "text": "n/a",
                "status": "-1",
                "output": "",
                "color": "#E6E6E6",
                "service_status": "0|0|0|0"
            }
        },
        "status": {
            "output": "Remote command execution failed: Could not create directory '/var/lib/nagios/.ssh'.",
            "text": "DOWN",
            "color": "#E7A1A2",
            "status": 2,
            "service_status": "14|0|0|16"
        }
    },
    "id": 1
}