Seitenvergleich

...

Seitenverzeichnis:

Inhalt

maxLevel	2
indent	10px
style	square

...

shd.filter.create

Erstellen eines Filter-Objekts.

Parameter

Parameter	Typ	Version
title	string	ab Version 1.0
obj_type_id	string	ab Version 1.0
display_rows	string	ab Version 1.0
page	string	ab Version 1.0
empty_values	string	ab Version 1.0
default	string	ab Version 1.0
display_relations	string	ab Version 1.0
locked_column	string	ab Version 1.0
columns	array	ab Version 1.0
condition	array	ab Version 1.0
context	-	ab Version 1.0

Rückgabewert

Wert	Typ	Version
filter_id	int	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{  
   "method":"shd.filter.create",
   "params":{  
      "apikey":"1ialbgclm9",
      "title":"Server KAtegorie",
      "obj_type_id":"5",
      "display_rows":"50",
      "page":"1",
      "default":"true",
      "empty_values":"0",
      "locked_column":"2",
      "display_relations":"0",
      "columns":[  
         {  
            "id":"670",
            "width":"80",
            "sort":""
         },
         {  
            "id":"682",
            "width":"80",
            "sort":""
         },
         {  
            "id":"679",
            "width":"50",
            "sort":""
         },
         {  
            "id":"676",
            "width":"50",
            "sort":""
         },
         {  
            "id":"630",
            "width":"50",
            "sort":""
         }
      ],
      "language":"en"
   },
   "id":1,
   "version":"2.0"
}

Codeblock

language	bash
theme	RDark

{
   "jsonrpc":"2.0",
   "result":{  
      "message":"filter.create.erfolg",
      "response":{  
         "filter_id": 5
      },
      "current_date":"2017-12-22"
   },
   "id":1
}

...

shd.filter.read

Auslesen von Detailinformationen eines Filter-Objekts.

Parameter

Parameter	Typ	Beschreibung	Version
filter_id	string	ID des zu holenden Filters	ab Version 1.0
obj_type_id	string	Für den Default-Filter	ab Version 1.0
user_id	string	ID des Benutzers	ab Version 1.0
count_objects	-	-	ab Version 1.0

Rückgabewert

Wert	Typ	Version
id	string	ab Version 1.0
title	string	ab Version 1.0
obj_type_id	string	ab Version 1.0
display_rows	string	ab Version 1.0
page	string	ab Version 1.0
user_id	string	ab Version 1.0
empty_values	string	ab Version 1.0
default	string	ab Version 1.0
display_relations	string	ab Version 1.0
columns	array	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{  
	"method": "shd.filter",
    "params": {
        "apikey": "20b61krclh",
        "filter_id": "3",
        "count_objects": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Codeblock

language	bash
theme	RDark

{
    "jsonrpc":"2.0",
    "result":{ 
        "shd_filter__id":"3",
        "shd_filter__title":"Layer 3-Net (1)",
        "shd_filter__obj_type_id":"31",
        "shd_filter__display_rows":"50",
        "shd_filter__page":"0",
        "shd_filter__user_id":"9",
        "shd_filter__default":"0",
        "shd_filter__display_relations":"0",
        "shd_filter__empty_values":"1",
        "shd_filter__columns":[ 
            { 
                "width":"240",
                "id":"C__CATG__GLOBAL-title",
                "sort":""
            },
            { 
                "width":"100",
                "id":"C__CATG__GLOBAL-cmdb_status",
                "sort":""
            },
            { 
                "width":"160",
                "id":"C__CATG__GLOBAL-created",
                "sort":""
            },
            { 
                "width":"160",
                "id":"C__CATG__GLOBAL-changed",
                "sort":""
            }
        ],
        "shd_filter__condition":[ 

        ],
        "count":"2"
    },
    "id":1
}

...

shd.filter.update

Bearbeiten eines Filter-Objekts.

Parameter

Parameter	Typ	Beschreibung	Version
filter_id	string	ID des zu holenden Filters	ab Version 1.0
title	string	Name des Filters	ab Version 1.0
obj_type_id	string	-	ab Version 1.0
display_rows	string	Die Anzahl der Elemente des Views	ab Version 1.0
page	string	-	ab Version 1.0
empty_values	string	-	ab Version 1.0
default	string	-	ab Version 1.0
display_relations	string	-	ab Version 1.0
locked_column	string	-	ab Version 1.0
columns	array	Ein Array von Column-Objekten	ab Version 1.0
condition	array	Ein Array von Condition-Objekten	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
message	string	filter.update.success"	ab Version 1.0
response	bool	true oder false	ab Version 1.0
current_date	string	-	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "params": {
        "columns": [
            {
                "width": 80,
                "sort": "",
                "id": "C__CATG__GLOBAL-title"
            }
        ],
        "title": "Neuer Test Filter",
        "obj_type_id": "5",
        "condition": [
            {
                "property": "",
                "category": "",
                "comparison": "LIKE %...%",
                "value": ""
            }
        ],
        "filter_id": "85",
        "locked_column": 0,
        "page": "0",
        "context": "Test_Context",
        "context_value": "Test_Value",
        "default": false,
        "display_rows": "22",
        "apikey": "1ialbgclm9"
    },
    "id": "1",
    "version": "2.0",
    "method": "shd.filter.update"
}

Codeblock

language	bash
theme	RDark

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "filter.update.success",
        "response": true,
        "current_date": "2019-01-28"
    }
}

...

shd.filter.delete

Löschen eines Filter-Objekts.

Parameter

Parameter	Typ	Beschreibung	Version
filter_id	string	ID des zu holenden Filters	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
message	string	filter.delete.success"	ab Version 1.0
response	bool	true oder false	ab Version 1.0
current_date	string	-	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "params": {
        "filter_id": "85",
        "apikey": "1ialbgclm9"
    },
    "id": "1",
    "version": "2.0",
    "method": "shd.filter.delete"
}

Codeblock

language	bash
theme	RDark

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "filter.delete.success",
        "response": true,
        "current_date": "2019-01-28"
    }
}

shd.filter.duplicate

Duplizieren eines Filters, einer anderen Personen-Gruppe oder einer anderen Person.

Parameter

Parameter	Typ	Beschreibung	Version
filter_id	string	ID des zu holenden Filters	ab Version 1.0
person_id	integer	ID des neuen Benutzers
person_group_id	integer	ID der neuen Benutzergruppe

Rückgabewert

Wert	Typ	Beschreibung	Version
message	string	filter.delete.success"	ab Version 1.0
response	integer	neue Filter-Id	ab Version 1.0
current_date	string	-	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "params": {
        "filter_id": "85",
		"person_id": "25",
        "apikey": "1ialbgclm9"
    },
    "id": "1",
    "version": "2.0",
    "method": "shd.filter.duplicate"
}

Codeblock

language	bash
theme	RDark

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "filter.duplicate.success",
        "response": 86,
        "current_date": "2019-04-08"
    }
}

...

shd.filter.query

Auslesen eines Filter-Views oder eines dynamischen Filter-Views.

Parameter

Parameter	Typ	Beschreibung	Version
filter_id	string	ID des zu holenden Filters	ab Version 1.0
obj_type_id	string	-	ab Version 1.0
display_rows	string	Die Anzahl der Elemente des Views	ab Version 1.0
page	String	Der Startindex der Elemente des Views	ab Version 1.0
column	array	Ein Array von Column-Objekten	ab Version 1.0
condition	array	Ein Array von Condition-Objekten	ab Version 1.0

Rückgabewert

Wert	Typ	Version
-	SHD.FilterView	ab Version 1.0

Trivia:

interne Weiterleitung zu shd.query.read

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

Codeblock

language	bash
theme	RDark

...

shd.filters.read

Auslesen eines Arrays von Filter-Objekten.

Parameter

Parameter	Typ	Beschreibung	Version
obj_type_id	string	Abfrage nach dem Typ des Filters	ab Version 1.0
display_rows	string	Die Anzahl der Elemente des Views	ab Version 1.0
page	String	Der Startindex der Elemente des Views	ab Version 1.0
column	array	Ein Array von Column-Objekten	ab Version 1.0
condition	array	Ein Array von Condition-Objekten	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
-	array	Array von Filter-Objekten	ab Version 1.0

Beispiel

Beispielaufruf

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "method": "shd.filters",
    "params": {
        "apikey": "20b61krclh",
        "obj_type_id": "31",
        "count_objects": false,
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Codeblock

language	bash
theme	RDark

{ 
    "jsonrpc":"2.0",
    "result":[ 
        { 
            "shd_filter__id":"2",
            "shd_filter__title":"Layer 3-Net neu",
            "shd_filter__obj_type_id":"31",
            "shd_filter__display_rows":"50",
            "shd_filter__page":"0",
            "shd_filter__user_id":"9",
            "shd_filter__default":"0",
            "shd_filter__display_relations":"0",
            "shd_filter__empty_values":"1",
            "shd_filter__columns":[ 
                { 
                    "width":"240",
                    "id":"C__CATG__GLOBAL-title",
                    "sort":""
                },
                { 
                    "width":"100",
                    "id":"C__CATG__GLOBAL-cmdb_status",
                    "sort":""
                },
                { 
                    "width":"160",
                    "id":"C__CATG__GLOBAL-created",
                    "sort":""
                },
                { 
                    "width":"160",
                    "id":"C__CATG__GLOBAL-changed",
                    "sort":""
                }
            ],
            "shd_filter__condition":[ 

            ],
            "count":"2"
        },
        { 
            "shd_filter__id":"3",
            "shd_filter__title":"Layer 3-Net (1)",
            "shd_filter__obj_type_id":"31",
            "shd_filter__display_rows":"50",
            "shd_filter__page":"0",
            "shd_filter__user_id":"9",
            "shd_filter__default":"0",
            "shd_filter__display_relations":"0",
            "shd_filter__empty_values":"1",
            "shd_filter__columns":[ 
                { 
                    "width":"240",
                    "id":"C__CATG__GLOBAL-title",
                    "sort":""
                },
                { 
                    "width":"100",
                    "id":"C__CATG__GLOBAL-cmdb_status",
                    "sort":""
                },
                { 
                    "width":"160",
                    "id":"C__CATG__GLOBAL-created",
                    "sort":""
                },
                { 
                    "width":"160",
                    "id":"C__CATG__GLOBAL-changed",
                    "sort":""
                }
            ],
            "shd_filter__condition":[ 

            ],
            "count":"2"
        },
		[...]
            "shd_filter__condition":[ 

            ],
            "count":"2"
        }
    ],
    "id":1
}

Seitenvergleich

Versionen im Vergleich

Alte Version 2

Neue Version Aktuell

Schlüssel

shd.filter.create

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort

shd.filter.read

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort

shd.filter.update

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort

shd.filter.delete

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort

shd.filter.duplicate

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort

shd.filter.query

Parameter

Rückgabewert

Trivia:

Beispiel

Beispielaufruf

Beispielantwort

shd.filters.read

Parameter

Rückgabewert

Beispiel

Beispielaufruf

Beispielantwort