Query

Owned by Thomas Wittek (Unlicensed)
Last updated: Dez. 02, 2020 by Maik Rhode (Unlicensed)
14 min read

Seitenverzeichnis: 


shd.query.read

Beschreibung

Auslesen einer selbst gebauten View.

Parameter

ParameterTypVersion
obj_type_idintab Version 1.0
display_rowsintab Version 1.0
pagestringab Version 1.0
columnsarray<Properties>ab Version 1.0
conditionComparisonab Version 1.0
status i-doit Statusab Version 1.0

Rückgabewert

WertTypVersion
numintab Version 1.0
contentgrid-viewab Version 1.0
headersarrayab Version 1.0
countintab Version 1.0
pagestringab Version 1.0
display_rowsstringab Version 1.0

Beispiel 

Beispielaufruf

Beispielantwort

 {
    "method": "shd.query.read",
    "params": {
        "apikey": "24174j3tqj",
        "obj_type_id": "5",
        "display_rows": "25",
        "page": "0",
        "columns": [
            {
                "id": "C__CATG__GLOBAL-title",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__GLOBAL-category",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__CPU-frequency",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__MEMORY-capacity",
                "width": "50",
                "sort": ""
            }
        ],
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}
{ 
    "jsonrpc":"2.0",
    "result":{ 
        "num":25,
        "content":{ 
            "63":{ 
                "__id__":"63",
                "LC__UNIVERSAL__TITLE":" AX-23784",
                "LC__CMDB__CATG__GLOBAL_CATEGORY":"",
                "LC__CMDB__CATG__FREQUENCY":[ 
                    { 
                        "__id__":null,
                        "value":""
                    }
                ],
                "LC__CMDB_CATG__MEMORY_CAPACITY":[ 
                    { 
                        "__id__":null,
                        "value":""
                    }
                ],
                "__index__":0
            },
            "369":{ 
                "__id__":"369",
                "LC__UNIVERSAL__TITLE":" HV-210-R2-SL2",
                "LC__CMDB__CATG__GLOBAL_CATEGORY":"",
                "LC__CMDB__CATG__FREQUENCY":[ 
                    { 
                        "__id__":null,
                        "value":""
                    }
                ],
                "LC__CMDB_CATG__MEMORY_CAPACITY":[ 
                    { 
                        "__id__":null,
                        "value":""
                    }
                ],
                "__index__":2
            },
            [...]
        },
        "headers":[ 
            { 
                "const":"LC__UNIVERSAL__TITLE",
                "title":"Bezeichnung"
            },
            { 
                "const":"LC__CMDB__CATG__GLOBAL_CATEGORY",
                "title":"Kategorie"
            },
            { 
                "const":"LC__CMDB__CATG__FREQUENCY",
                "title":"CPU-Frequenz"
            },
            { 
                "const":"LC__CMDB_CATG__MEMORY_CAPACITY",
                "title":"Kapazit\u00e4t"
            }
        ],
        "count":596,
        "page":"0",
        "display_rows":"25"
    },
    "id":1
}

shd.query.relation

Beschreibung

Holt alle Elemente eines Parent-Objects.

Parameter

ParameterTypVersion
obj_idintab Version 1.0
display_rowsintab Version 1.0
pagestringab Version 1.0
columnsarray<Properties>ab Version 1.0
conditionComparisonab Version 1.0
status i-doit Statusab Version 1.0

Rückgabewert

WertTypVersion
numintab Version 1.0
contentarray ab Version 1.0
headersarrayab Version 1.0
countintab Version 1.0
pagestringab Version 1.0
display_rowsstringab Version 1.0

Beispielaufruf

{
    "method": "shd.query.relation",
    "params": {
        "apikey": "24174j3tqj",
        "obj_id": "80",
        "display_rows": "25",
        "page": "0",
        "columns": [
            {
                "id": "C__CATG__GLOBAL-title",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__GLOBAL-category",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__CPU-frequency",
                "width": "50",
                "sort": ""
            },
            {
                "id": "C__CATG__MEMORY-capacity",
                "width": "50",
                "sort": ""
            }
        ],
        "debug": true,
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

Beispielantwort

{
    "jsonrpc": "2.0",
    "result": {
        "num": 25,
        "content": {
            "81": {
                "__id__": "81",
                "LC__UNIVERSAL__TITLE": "demo-smbox5",
                "LC__CMDB__CATG__GLOBAL_CATEGORY": "",
                "LC__CMDB__CATG__FREQUENCY": [
                    {
                        "__id__": null,
                        "value": ""
                    }
                ],
                "LC__CMDB_CATG__MEMORY_CAPACITY": [
                    {
                        "__id__": null,
                        "value": ""
                    }
                ],
                "__index__": 1
            },
            "87": {
                "__id__": "87",
                "LC__UNIVERSAL__TITLE": "HV-210-R1-PF-A",
                "LC__CMDB__CATG__GLOBAL_CATEGORY": "",
                "LC__CMDB__CATG__FREQUENCY": [
                    {
                        "__id__": null,
                        "value": ""
                    }
                ],
                "LC__CMDB_CATG__MEMORY_CAPACITY": [
                    {
                        "__id__": null,
                        "value": ""
                    }
                ],
                "__index__": 8
            },
          [...]
        },
        "headers": [
            {
                "const": "LC__UNIVERSAL__TITLE",
                "title": "Bezeichnung"
            },
            {
                "const": "LC__CMDB__CATG__GLOBAL_CATEGORY",
                "title": "Kategorie"
            }
            [...]
        ],
        "count": 27,
        "page": "0",
        "display_rows": null
    },
    "id": 1
}
}

shd.query.category

Beschreibung

Abfragen der Eigenschaften von Kategorien.

Parameter

ParameterTypVersion
columnsarrayab Version 1.0
conditionarrayab Version 1.0

Rückgabewert

WertTypVersion
display_rowsstringab Version 1.0
contentarrayab Version 1.0
timedoubleab Version 1.0
countintab Version 1.0
headersarrayab Version 1.0
totalintab Version 1.0
pagestringab Version 1.0

Beispielaufruf

{
  "id" : "1",
  "version" : "2.0",
  "params" : {
    "columns" : [
      {
        "sort" : "",
        "id" : "C__CATG__MEMORY-title"
      },
      {
        "sort" : "",
        "id" : "C__CATG__MEMORY-unit"
      },
      {
        "sort" : "",
        "id" : "C__CATG__MEMORY-total_capacity"
      }
    ],
    "apikey" : "1ialbgclm9",
    "condition" : [
      {
        "value" : "2731",
        "comparison" : "=",
        "property" : "C__CATG__GLOBAL-id",
        "category" : "C__CATG__GLOBAL"
      }
    ],
    "page" : "0"
  },
  "method" : "shd.query.category"
}
{
    "method": "shd.query.category",
    "id": "1",
    "params": {
        "debug":"true",
        "display_rows": "50",
        "condition": [
            {
                "comparison": "=",
                "property": "map_id",
                "category": "C__CATG__MAP",
                "value": "6"
            }
        ],
        "apikey": "365478025",
        "columns": [
            {
                "width": "140",
                "id": "C__CATG__LIVESTATUS-check_command",
                "sort": ""
            },
            {
                "width": "140",
                "id": "C__CATG__LIVESTATUS-check_interval",
                "sort": ""
            }
        ],
        "language": "de",
        "page": "0"
    },
    "jsonrpc": "2.0"
}

Beispielantwort

{
    "jsonrpc": "2.0",
    "result": {
        "display_rows": "0",
        "content": {
            "355": {
                "C__CATG__MEMORY-unit": {
                    "3": {
                        "value": "GB",
                        "__id__": "3"
                    }
                },
                "__id__": "355",
                "__index__": "0",
                "C__CATG__MEMORY-total_capacity": "0",
                "C__CATG__MEMORY-title": {
                    "6": {
                        "value": "LRDIMM",
                        "__id__": "6"
                    }
                }
            },
            "356": {
                "C__CATG__MEMORY-unit": {
                    "3": {
                        "value": "GB",
                        "__id__": "3"
                    }
                },
                "__id__": "356",
                "__index__": "0",
                "C__CATG__MEMORY-total_capacity": "0",
                "C__CATG__MEMORY-title": {
                    "6": {
                        "value": "LRDIMM",
                        "__id__": "6"
                    }
                }
            },
            "357": {
                "C__CATG__MEMORY-unit": {
                    "3": {
                        "value": "GB",
                        "__id__": "3"
                    }
                },
                "__id__": "357",
                "__index__": "0",
                "C__CATG__MEMORY-total_capacity": "0",
                "C__CATG__MEMORY-title": {
                    "6": {
                        "value": "LRDIMM",
                        "__id__": "6"
                    }
                }
            }
            [...]
        },
        "time": 0.16799998283386,
        "count": 16,
        "headers": [
            {
                "const": "C__CATG__MEMORY-title",
                "title": "Title"
            },
            {
                "const": "C__CATG__MEMORY-unit",
                "title": "Memory unit"
            },
            {
                "const": "C__CATG__MEMORY-total_capacity",
                "title": "Total capacity"
            }
        ],
        "total": 16,
        "page": "0"
    },
    "id": "1"
}

(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/