Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Seitenverzeichnis: 

...

shd.object.duplicate

Beschreibung

Ist eine Hilfsfunktion zum duplizieren von Objekten.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "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"
}

...

ParameterTypBeschreibungVersion
ObjIdstringID des Objektesab Version 1.0
down_lvlstring

Die Anzahl der Elemente des Views

ab Version 1.0
up_lvlstringDie Anzahl der Elemente des Viewsab Version 1.0
columnsarray-ab Version 1.0
process_idintKann gesetzt werden um den Prozess später abzubrechenab Version 1.0

...

ParameterTypBeschreibungVersion
ObjIdstringID des Objektesab Version 1.0
down_lvlstring

Die Anzahl der Elemente des Views

ab Version 1.0
up_lvlstringDie Anzahl der Elemente des Viewsab Version 1.0
columnsarray-ab Version 1.0
process_idintKann gesetzt werden um den Prozess später abzubrechenab Version 1.0

...

WertTypBeschreibungVersion
-arrayEin Array von Objekt-Typenab Version 1.0

shd.object.check_delete

Beschreibung

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

Beispielaufruf

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

Beispielantwort

Codeblock
languagebash
themeRDark
{
    "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

ParameterTypBeschreibungVersion
obj_idstringID des Objektesab Version 1.3

Rückgabewert

WertTypBeschreibungVersion
-arrayEin Array von Objektenab 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

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

Beispielantwort

Codeblock
languagebash
themeRDark
{
    "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

ParameterTypBeschreibungVersion
valuestringTitel des Objektesab Version 1.3
obj_idintOptional: ID des zu prüfenden Objektesab Build 2120
obj_type_idintOptional: ID des zu prüfenden Objekttypesab Build 2120
propertiesarray

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

WertTypBeschreibungVersion
Result-Objektarray
ab Version 1.3