Seitenvergleich

Seitenverzeichnis:

Inhalt

maxLevel	2
indent	10px
style	square

...

cmdb.

...

category.

...

read

Beschreibung

Ist eine Hilfsfunktion zum duplizieren von ObjektenAlle Wartungen eines Objektes auslesen.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method": "shdcmdb.objectcategory.duplicateread",
    	"params": {
        		"apikey": "1ialbgclm9dzr7u7tu",
		"objID": 80593,
		"category": "C__CATG__UKD_MAINTENANCE"
	}
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "id": [1,
       "jsonrpc": "2.0",
    "736result",: [
         {
 "741",           "id":  "12722",
        ],    "objID": "9",
   "category": [        "title": {
   "1",             "89"id": "5",
            "145",    "title": "System neugestartet",
      "146",            "const": "147SYSTEM",
             "149",   "title_lang": "System neugestartet"
            "135"},
            "136time": "18.03.2020    - 11:02",
   ],         "export_specific_catguser": "on",{
        "custom_category": [       "id": "9",
    "8"         ],         "update_globals"title": "1admin ",
  
     "object_title": "new Title",         "duplicate_optionssysid": "0SYSID_1280838787",
  
     "language": "en"     },     "idtype": 1"C__OBJTYPE__PERSON",
    "version": "2.0"
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{            "jsonrpctype_title": "2.0Persons",
     "result": {      },
  "success": true,         "responseticket": {"1137509",
            "importedinformation": [null
        }
       "5147",
                "5148",
                "5149"
            ]
        },
        "message": null
    },
    "id": 1
}

Parameter

...

]
}

Parameter

Typ

Beschreibung

Version

objID

int

Objekt-ID des betreffenden Objektes

ab Version 1.0

category

string

Konstante der entsprechenden Kategorie.

Die Konstante der Wartungs-Kategorie lautet: "C__CATG__UKD_MAINTENANCE"

ab Version 1.0

Rückgabewert

int

Wert	Typ	Beschreibung	Version
id	int	ID des Kategorie-Eintrages	ab Version 1.0
objID	int	Objekt-ID des betreffenden Objektes	ab Version 1.0
title	object	Zugewiesene Titel-Referenz	ab Version 1.0
time	string	Zeitpunkt, an dem der Eintrag angelegt wurde	ab Version 1.0
user	object	Referenz zum Nutzer, welcher den Eintrag angelegt hat	ab Version 1.0

category

ticket

string

Ticket-Nummer

ab Version 1.0

export_specific_catg

information

string

Weitere Informationen zur Wartung

ab Version 1.0

custom_

...

cmdb.category.create

...

Rückgabewert

...

shd.object.relation

Beschreibung

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

Beispielaufruf

...

language	bash
theme	RDark

...

Beschreibung

Legt eine neue Wartung an.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.save",
	"params": {
		"apikey": "dzr7u7tu",
		"object": 80593,
		"category": "C__CATG__UKD_MAINTENANCE",
		"data": {
			"user": 8,
            "ObjIdtitle": "583",5,
            "down_lvltime": "12020-03-19 22:44:00",
        "up_lvl    "ticket": "11137123",

		}
	}
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "columnsid": {1,
       "jsonrpc": "2.0",
    "C__OBJTYPE__ALLresult": [                 {
          "id": 9,
         "idmessage": "C__CATG__GLOBAL-title"
 Category entry successfully created.",
        "success": true
    },
                {
                    "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

Codeblock

language	bash
theme	RDark

{
    "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

...

Die Anzahl der Elemente des Views

...

Rückgabewert

...

shd.object.relationfast

Beschreibung

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

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
    "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

Codeblock

language	bash
theme	RDark

{ 
    "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

...

Die Anzahl der Elemente des Views

...

Rückgabewert

...

shd.object.check_delete

Beschreibung

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

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "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",
       
}

Parameter

Parameter	Typ	Beschreibung	Version
object	int	Objekt-ID des betreffenden Objektes	ab Version 1.0
category	string	Konstante der entsprechenden Kategorie. Die Konstante der Wartungs-Kategorie lautet: "C__CATG__UKD_MAINTENANCE"	ab Version 1.0
title	int	ID der Titel-Referenz	ab Version 1.0
time	string	Zeitpunkt der Wartung	ab Version 1.0
user	int	ID des eintragenden Nutzers	ab Version 1.0
ticket	array	Optional: Ticket-Nummer	ab Version 1.0
information	string	Optional: Weitere Informationen zur Wartung	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
success	boolean	Gibt an, ob die Aktion erfolgreich ausgeführt wurde	ab Version 1.0
message	string	Entsprechende Rückgabemeldung	ab Version 1.0

...

cmdb.category.update

Beschreibung

Aktualisiert eine bestehende Wartung.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.save",
	"params": {
		"apikey": "dzr7u7tu",
		"object": 80593,
		"category": "C__CATG__UKD_MAINTENANCE",
		"id": 6,
		"data": {
			"user": 7,
			"title": 5,
			"time": "2020-03-19 22:22:00"
		}
	}
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "obj_idsuccess": "157"
            },
        true,
  [...]      "message": "Category entry ]successfully saved."
    }
}

Parameter

Parameter	Typ

BeschreibungVersionobj_idstringID des Objektes

Beschreibung

Version

object

int

Objekt-ID des betreffenden Objektes

ab Version 1.0

category

string

Konstante der entsprechenden Kategorie.

Die Konstante der Wartungs-Kategorie lautet: "C__CATG__UKD_MAINTENANCE"

ab Version 1.0

id

int

ID des Kategorie-Eintrages

ab Version 1.

3

0

...

title

WertTypBeschreibungVersion-arrayEin Array von Objekten

int	ID der Titel-Referenz	ab Version 1.0
time	string	Zeitpunkt der Wartung	ab Version 1.

3

shd.object.validate

Beschreibung

Prüft die Werte des Objektes auf Korrektheit.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
    "method": "shd.object.validate",
    "id": "1",
    "params": {
        "value": "Kabel 1",
        "obj_type_id": "C__SHD__TELECOMMUNICATION_CABLE",
        "apikey": "1ialbgclm9",
        "language": "de"
    },
    "jsonrpc": "2.0"
}

...

0
user	int	ID des eintragenden Nutzers	ab Version 1.0
ticket	string	Ticket-Nummer	ab Version 1.0
information	string	Weitere Informationen zur Wartung	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
success	boolean	Gibt an, ob die Aktion erfolgreich ausgeführt wurde	ab Version 1.0
message	string	Entsprechende Rückgabemeldung	ab Version 1.0

...

cmdb.category.delete

Beschreibung

Löscht eine Wartung.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": "1",
    "jsonrpc	"method": "2cmdb.category.0create",
    "result	"params": {
        "message		"apikey": "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>""dzr7u7tu",
        "objID": 80593,
        "successcategory": false"C__CATG__UKD_MAINTENANCE",
        "dataid": 8

	}
{
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{
      "id": 1,
    "titlejsonrpc": "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>"2.0",
    "result": {
        "success": true,
        "message": "Category entry  }'8' successfully deleted"
    }
}

Parameter

...

Parameter

Typ

Beschreibung

Version

objID

int

Objekt-ID des betreffenden Objektes

ab Version 1.0

category

string

Konstante der entsprechenden Kategorie.

Die Konstante der Wartungs-Kategorie lautet: "C__CATG__UKD_MAINTENANCE"

ab Version 1.0

id

int

ID des Kategorie-Eintrages

ab Version 1.

3

0

Rückgabewert

3

Wert	Typ	Beschreibung	Version
success	boolean	Gibt an, ob die Aktion erfolgreich ausgeführt wurde	ab Version	Result-Objekt	array1.0
message	string	Entsprechende Rückgabemeldung	ab Version 1.	0

Seitenvergleich

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

cmdb.

category.

read

Beschreibung

Beispielaufruf

Beispielantwort

Beispielantwort

Parameter

Parameter

Rückgabewert

cmdb.category.create

Rückgabewert

shd.object.relation

Beschreibung

Beispielaufruf

Beschreibung

Beispielaufruf

Beispielantwort

Beispielantwort

Parameter

Rückgabewert

shd.object.relationfast

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

Rückgabewert

shd.object.check_delete

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

Rückgabewert

cmdb.category.update

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

shd.object.validate

Beschreibung

Beispielaufruf

Rückgabewert

cmdb.category.delete

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

Parameter

Rückgabewert