Wartung

Seitenverzeichnis:

cmdb.category.read

Beschreibung

Alle Wartungen eines Objektes auslesen.

Beispielaufruf

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.read",
	"params": {
		"apikey": "dzr7u7tu",
		"objID": 80593,
		"category": "C__CATG__UKD_MAINTENANCE"
	}
}

Beispielantwort

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "2",
            "objID": "9",
            "title": {
                "id": "5",
                "title": "System neugestartet",
                "const": "SYSTEM",
                "title_lang": "System neugestartet"
            },
            "time": "18.03.2020 - 11:02",
            "user": {
                "id": "9",
                "title": "admin ",
                "sysid": "SYSID_1280838787",
                "type": "C__OBJTYPE__PERSON",
                "type_title": "Persons"
            },
            "ticket": "1137509",
            "information": null
        }
    ]
}

Parameter

Typ

Beschreibung

Version

objID

int

Objekt-ID des betreffenden Objektes

ab Version 1.0

Rückgabewert

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
ticket	string	Ticket-Nummer	ab Version 1.0
information	string	Weitere Informationen zur Wartung	ab Version 1.0

cmdb.category.create

Beschreibung

Legt eine neue Wartung an.

Beispielaufruf

{
	"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,
            "title": 5,
            "time": "2020-03-19 22:44:00",
            "ticket": "1137123"

		}
	}
}

Beispielantwort

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "id": 9,
        "message": "Category entry successfully created.",
        "success": true
    }
}

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

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

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "success": true,
        "message": "Category entry successfully saved."
    }
}

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
id	int	ID des Kategorie-Eintrages	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	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

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.create",
	"params": {
		"apikey": "dzr7u7tu",
        "objID": 80593,
        "category": "C__CATG__UKD_MAINTENANCE",
        "id": 8

	}
}

Beispielantwort

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "success": true,
        "message": "Category entry '8' successfully deleted"
    }
}

Parameter

Typ

Beschreibung

Version

objID

int

Objekt-ID des betreffenden Objektes

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