Vertragszuweisung

Seitenverzeichnis:

cmdb.category.read

Beschreibung

Alle Vertragszuweisungen 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_CONTRACT_ASSIGNMENT"
	}
}

Beispielantwort

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "1",
            "objID": "80593",
            "connected_contract": {
                "title": "UKD SLA 01",
                "id": "81006",
                "connection_id": "1215",
                "type": "C__UKD__CONTRACT",
                "type_title": "UKD Vertrag",
                "sysid": "SYSID_1584788058"
            },
            "start_date": "23.03.2020",
            "end_date": "25.03.2020",
            "serial_number": "",
            "sap_number": "",
            "type": {
                "id": "5",
                "title": "Absprache intern",
                "const": null,
                "title_lang": "Absprache intern"
            }
        }
    ]
}

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
connected_contract	object	Zugewiesenes Vertragsobjekt	ab Version 1.0
start_date	string	Start-Datum des Vertrages	ab Version 1.0
end_date	string	End-Datum des Vertrages	ab Version 1.0
serial_number	string	Seriennummer	ab Version 1.0
sap_number	string	SAP Nummer	ab Version 1.0
type	object	Referenz zum Typ der Vertragszuweisung	ab Version 1.0

cmdb.category.create

Beschreibung

Legt eine neue Vertragszuweisung an.

Beispielaufruf

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.save",
	"params": {
		"apikey": "dzr7u7tu",
		"object": 80593,
		"category": "C__CATG__UKD_CONTRACT_ASSIGNMENT",
		"data": {
			"connected_contract": 81006,
			"start_date": "23.03.2020",
            "end_date": "25.03.2020",
            "serial_number": "1234",
            "sap_number": "5678",
            "type": 4

		}
	}
}

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_CONTRACT_ASSIGNMENT"	ab Version 1.0
connected_contract	int	Objekt-ID des zugewiesenen Vertrages	ab Version 1.0
start_date	string	Start-Datum des Vertrages	ab Version 1.0
end_date	string	End-Datum des Vertrages	ab Version 1.0
serial_number	string	Optional: Seriennummer	ab Version 1.0
sap_number	string	Optional: SAP Nummer	ab Version 1.0
type	int	Referenz zum Typ der Vertragszuweisung	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 Vertragszuweisung.

Beispielaufruf

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.save",
	"params": {
		"apikey": "dzr7u7tu",
		"object": 80593,
		"category": "C__CATG__UKD_CONTRACT_ASSIGNMENT",
		"id": 14,
		"data": {
			"connected_contract": 81006,
            "serial_number": "1234",
            "sap_number": "5678",
            "type": 4

		}
	}
}

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_CONTRACT_ASSIGNMENT"	ab Version 1.0
id	int	ID des Kategorie-Eintrages	ab Version 1.0
connected_contract	int	Objekt-ID des zugewiesenen Vertrages	ab Version 1.0
start_date	string	Start-Datum des Vertrages	ab Version 1.0
end_date	string	End-Datum des Vertrages	ab Version 1.0
serialnumber	string	Seriennummer	ab Version 1.0
sap_number	string	Weitere Informationen zur Wartung	ab Version 1.0
type	int	Referenz zum Typ der Vertragszuweisung	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 Vertragszuweisung.

Beispielaufruf

{
	"jsonrpc": "2.0",
	"version": "2.0",
	"id": 1,
	"method":"cmdb.category.create",
	"params": {
		"apikey": "dzr7u7tu",
        "objID": 80593,
        "category": "C__CATG__UKD_CONTRACT_ASSIGNMENT",
        "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