Object

Seitenverzeichnis:

shd.object.duplicate

Beschreibung

Ist eine Hilfsfunktion zum duplizieren von Objekten.

Beispielaufruf

{
    "method": "shd.object.duplicate",
    "params": {
        "apikey": "1ialbgclm9",
        "id": [
            "736",
            "741",
            "1272"
        ],
        "category": [
            "1",
            "89",
            "145",
            "146",
            "147",
            "149",
            "135",
            "136"
        ],
        "export_specific_catg": "on",
        "custom_category": [
            "8"
        ],
        "update_globals": "1",
        "object_title": "new Title",
        "duplicate_options": "0",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Beispielantwort

{
    "jsonrpc": "2.0",
    "result": {
        "success": true,
        "response": {
            "imported": [
                "5147",
                "5148",
                "5149"
            ]
        },
        "message": null
    },
    "id": 1
}

Parameter

Parameter	Typ	Version
id	int	ab Version 1.0
category	int	ab Version 1.0
export_specific_catg	string	ab Version 1.0
custom_category	string	ab Version 1.0
update_globals	int	ab Version 1.0
object_title	string	ab Version 1.0
duplicate_options	bool	ab Version 1.0

Rückgabewert

Wert	Typ	Version
succes	bool	ab Version 1.0
response	array	ab Version 1.0
message	string	ab Version 1.0

shd.object.relation

Beschreibung

Gibt alle Objekte zurück die in einer Beziehung zum angegebenen Objekt stehen.

Beispielaufruf

{
    "method": "shd.object.relation",
    "params": {
        "apikey": "1ialbgclm9",
        "ObjId": "583",
        "down_lvl": "1",
        "up_lvl": "1",
        "columns": {
            "C__OBJTYPE__ALL": [
                {
                    "id": "C__CATG__GLOBAL-title"
                },
                {
                    "id": "C__CATG__GLOBAL-description"
                },
                {
                    "id": "C__CATG__GLOBAL-status"
                },
                {
                    "id": "C__CATG__CPU-frequency"
                }
            ],
            "C__OBJTYPE__SERVER": [
                {
                    "id": "C__CATG__CPU-frequency"
                }
            ]
        },
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Beispielantwort

{
    "jsonrpc": "2.0",
    "result": {
        "33": {
            "data": {
                "isys_obj__id": "584",
                "isys_obj__title": "ACME Headquarter (HQ) ist Standort von 1.11 Copy Room",
                "isys_obj_type__id": "60",
                "isys_obj_type__title": "Gebäude",
                "isys_catg_relation_list__isys_obj__id__master": "33",
                "isys_catg_relation_list__isys_obj__id__slave": "583",
                "isys_catg_relation_list__isys_obj__id": "584",
                "related": "33",
                "related_title": "ACME Headquarter (HQ)",
                "related_type_title": "Gebäude",
                "related_type": "3",
                "related_cmdb_status_id": null,
                "related_cmdb_status_title": "In Betrieb",
                "up_lvl": 1,
                "category": {
                    "C__CATG__GLOBAL-title": "ACME Headquarter (HQ)",
                    "C__CATG__GLOBAL-description": "",
                    "C__CATG__GLOBAL-status": "Normal"
                }
            },
            "children": false
        },
        "237": {
            "data": {
                "isys_obj__id": "586",
                "isys_obj__title": "IT Operations wird benutzt von 1.11 Copy Room",
                "isys_obj_type__id": "60",
                "isys_obj_type__title": "Personengruppen",
                "isys_catg_relation_list__isys_obj__id__master": "237",
                "isys_catg_relation_list__isys_obj__id__slave": "583",
                "isys_catg_relation_list__isys_obj__id": "586",
                "related": "237",
                "related_title": "IT Operations",
                "related_type_title": "Personengruppen",
                "related_type": "54",
                "related_cmdb_status_id": null,
                "related_cmdb_status_title": "In Betrieb",
                "up_lvl": 1,
                "category": {
                    "C__CATG__GLOBAL-title": "IT Operations",
                    "C__CATG__GLOBAL-description": "",
                    "C__CATG__GLOBAL-status": "Normal"
                }
            },
            "children": false
        }, 
		[…]
    },
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
ObjId	string	ID des Objektes	ab Version 1.0
down_lvl	string	Die Anzahl der Elemente des Views	ab Version 1.0
up_lvl	string	Die Anzahl der Elemente des Views	ab Version 1.0
columns	array	-	ab Version 1.0
process_id	int	Kann gesetzt werden um den Prozess später abzubrechen	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
	array	Ein Array von Objekt-Typen	ab Version 1.0

shd.object.relationfast

Beschreibung

Gibt alle Objekte zurück die in einer Beziehung zum angegebenen Objekt stehen.

Beispielaufruf

{
    "method": "shd.object.relation",
    "params": {
        "apikey": "1ialbgclm9",
        "ObjId": "583",
        "down_lvl": "1",
        "up_lvl": "1",
        "columns": {
            "C__OBJTYPE__ALL": [
                {
                    "id": "C__CATG__GLOBAL-title"
                },
                {
                    "id": "C__CATG__GLOBAL-description"
                },
                {
                    "id": "C__CATG__GLOBAL-status"
                },
                {
                    "id": "C__CATG__CPU-frequency"
                }
            ],
            "C__OBJTYPE__SERVER": [
                {
                    "id": "C__CATG__CPU-frequency"
                }
            ]
        },
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Beispielantwort

{ 
    "jsonrpc":"2.0",
    "result":{ 
        "583":{ 
            "data":{ 
                "related_title":"1.11 Copy Room",
                "related_type_title":"Raum",
                "isys_obj_type__title":"Raum",
                "related_type":"26",
                "related_cmdb_status_id":null,
                "related_cmdb_status_title":"In Betrieb",
                "related":"583",
                "category":{ 
                    "C__CATG__GLOBAL-title":"1.11 Copy Room",
                    "C__CATG__GLOBAL-description":"",
                    "C__CATG__GLOBAL-status":"Normal"
                }
            },
            "children":false
        },
        "33":{ 
            "data":{ 
                "isys_obj__id":"584",
                "isys_obj__title":"ACME Headquarter (HQ) ist Standort von 1.11 Copy Room",
                "isys_obj_type__id":"60",
                "isys_obj_type__title":"Geb\u00e4ude",
                "isys_catg_relation_list__isys_obj__id__master":"33",
                "isys_catg_relation_list__isys_obj__id__slave":"583",
                "isys_catg_relation_list__isys_obj__id":"584",
                "related":"33",
                "related_title":"ACME Headquarter (HQ)",
                "related_type_title":"Geb\u00e4ude",
                "related_type":"3",
                "related_cmdb_status_id":null,
                "related_cmdb_status_title":"In Betrieb",
                "up_lvl":1,
                "category":{ 
                    "C__CATG__GLOBAL-title":"ACME Headquarter (HQ)",
                    "C__CATG__GLOBAL-description":"",
                    "C__CATG__GLOBAL-status":"Normal"
                }
            },
            "children":false
        },
    	[…]
    },
    "id":1
}

Parameter

Parameter	Typ	Beschreibung	Version
ObjId	string	ID des Objektes	ab Version 1.0
down_lvl	string	Die Anzahl der Elemente des Views	ab Version 1.0
up_lvl	string	Die Anzahl der Elemente des Views	ab Version 1.0
columns	array	-	ab Version 1.0
process_id	int	Kann gesetzt werden um den Prozess später abzubrechen	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
-	array	Ein Array von Objekt-Typen	ab Version 1.0

shd.object.check_delete

Beschreibung

Gibt alle Beziehungen zurück die beim löschen, gelöscht werden.

Beispielaufruf

{
    "method": "shd.object.check_delete",
    "id": "1",
    "params": {
        "obj_id": "157",
        "apikey": "1ialbgclm9",
        "language": "de"
    },
    "jsonrpc": "2.0"
}

Beispielantwort

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "data": [
            {
                "title": "Staff hat Mitglied Adam Riese",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Anna Bolika",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Falk Narei",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Hans Olo",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Helga Inbrunst",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Klaus Diemaus",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Lukas Himmelsläufer",
                "obj_id": "157"
            },
            {
                "title": "Staff hat Mitglied Lutz Sensemann",
                "obj_id": "157"
            },
           [...]
        ]
    }
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	string	ID des Objektes	ab Version 1.3

Rückgabewert

Wert	Typ	Beschreibung	Version
-	array	Ein Array von Objekten	ab Version 1.3

shd.object.validate

Beschreibung

Prüft, ob der Bezeichner eines Objektes eindeutig ist.

Optional kann die Eindeutigkeit auch anhand der Angabe mehrerer Eigenschaften festgestellt werden.

Beispielaufruf

{
    "method": "shd.object.validate",
    "id": "1",
    "params": {
        "value": "Kabel 1",
        "obj_type_id": "C__SHD__TELECOMMUNICATION_CABLE",
		"properties": {
			"title": "Kabel 1",
			"purpose": "ISDN",
			"category": "",
			"cmdb_status": "",
			"status": 2,
			"location": 1234
		}
        "apikey": "1ialbgclm9",
        "language": "de"
    },
    "jsonrpc": "2.0"
}

Beispielantwort

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "Der eingegebene Wert wird bereits in anderen Objekten des gleichen Typs verwendet:<ul class=\"m0 mt10 list-style-none\"><li><span>Fernmelde-Kabel » F 112</span></li></ul>",
        "success": false,
        "data": {
            "title": "Der eingegebene Wert wird bereits in anderen Objekten des gleichen Typs verwendet:<ul class=\"m0 mt10 list-style-none\"><li><span>Fernmelde-Kabel » F 112</span></li></ul>"
        }
    }
}

Parameter

Parameter	Typ	Beschreibung	Version
value	string	Titel des Objektes	ab Version 1.3
obj_id	int	Optional: ID des zu prüfenden Objektes	ab Build 2120
obj_type_id	int	Optional: ID des zu prüfenden Objekttypes	ab Build 2120
properties	array	Optional: Liste zu prüfender Eigenschaften Mögliche Eigenschaften sind: title: Bezeichnung der Objektes Typ: String Zulässige Werte: alle Beispiel: "Element01" erforderlich: nur ohne Angabe der obj_id purpose: Einsatzzweck Typ: String Zulässige Werte: Alle Bezeichner aus isys_purpose Beispiel: "CU", "LWL" erforderlich: nein category: Kategorie Typ: String Zulässige Werte: Alle Bezeichner aus isys_catg_global_category Beispiel: "LAN", "Dosen" erforderlich: nein cmdb_status: CMDB-Status Typ: Integer oder String Zulässige Werte: Alle CMDB-Status-IDs oder -Konstanten aus isys_cmdb_status Beispiel: 2, "C__CMDB_STATUS__IN_OPERATION" erforderlich: nein status: Status des Objektes Typ: Integer Zulässige Werte: Alle IDs aus isys_obj Beispiel: 2 erforderlich: nein location: Objekt-ID des übergeordneten Standortes Typ: Integer Zulässige Werte: Alle Objekt-IDs denen ein Standort zugewiesen ist Beispiel: 1234 erforderlich: nein Bezieht sich auf: https://smdocu.atlassian.net/l/cp/QWWHRLN7	ab Build 2168

Rückgabewert

Wert	Typ	Beschreibung	Version
Result-Objekt	array		ab Version 1.3