CMDBQueryBuilderAPI : Global

CMDBQueryBuilderAPI – createReport(String speicherndQueryId, Zeichenfolge gespeicherter AbfrageName)

Erstellt einen Bericht, der die Ergebnisse einer Configuration Management Database (CMDB) -Abfragegeneratorabfrage anzeigt, und gibt die URL des Berichts zurück.

Tabelle : 1. Parameter
Name	Typ	Beschreibung
savedQueryId	Zeichenfolge	Sys_id der Abfrage, die für den Bericht verwendet werden soll. Dieser Parameter ist nicht erforderlich, wenn ein Abfragename angegeben wird. Tabelle: Gespeicherte Abfragen [qb_saved_query]
gespeicherterAbfragename	Zeichenfolge	Name der für den Bericht zu verwendenden Abfrage. Dieser Parameter ist nicht erforderlich, wenn eine Abfrage-sys_id angegeben wird. Tabelle: Wird im Feld Name der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.

Tabelle : 2. Rückgaben
Typ	Beschreibung
Objekt	Details zum erstellten Bericht und zu Fehlern. `{ "error": "String", "message": "String", "status": "String" }`
<Object>.Fehler	Fehlercode. Wird zurückgegeben, wenn die Berichterstellung fehlschlägt oder ungültige Eingabeparameter angegeben werden. Mögliche Fehler: `ANWENDER_NICHT_AUTORISIERT_AUSGABE` `INVALID_PARAM` `QUERY_SYS_ID_INVALID` Datentyp: Zeichenfolge
<Object>.message	Nachricht, die Details über den Erfolg oder Fehler der Berichterstellung enthält. Mögliche Nachrichten: `<report-url>` `Anwender ist nicht zum Erstellen eines CMDBQueryBuilder-Abfrageberichts berechtigt` `Ungültige Parameter. Geben Sie entweder eine gültige sysId oder den gültigen Namen einer gespeicherten Abfrage an` `Ungültige Abfrage-ID. Geben Sie eine gültige gespeicherte Abfrage-ID an` Datentyp: Zeichenfolge
<Object>.status	Statuscode. Wird zurückgegeben, wenn das Update erfolgreich ist. Wert: `Erfolg` Datentyp: Zeichenfolge

In diesem Beispiel wird gezeigt, wie Sie einen Bericht erstellen, indem Sie einen gespeicherten Abfragenamen übergeben.

SNC.CMDBQueryBuilderAPI.createReport('', 'CMDBQueryTest1');

Ausgabe:

{
   "message":"\/sys_report_template.do?sysparm_report_source_id=6d299cf81bbd4210bccf42a3b24bcb7a&sysparm_type=list&sysparm_title=CMDBQueryTest1&sysparm_source_type=source&sysparm_from_list=true&sysparm_chart_size=large&sysparm_manual_labor=true",
   "status":"success"
}

In diesem Beispiel wird ein Fehler angezeigt, wenn der angegebene Abfragename ungültig ist.

SNC.CMDBQueryBuilderAPI.createReport('', 'Test');

Ausgabe:

{
   "error":"INVALID_PARAM",
   "message":"Invalid Parameters. Please provide either a valid sysId or a valid name of a saved query"
}

CMDBQueryBuilderAPI – deleteQuery(String speicherndQueryId, Zeichenfolge gespeicherter AbfrageName)

Löscht eine Configuration Management Database (CMDB) Abfragegeneratorabfrage.

Tabelle : 3. Parameter
Name	Typ	Beschreibung
savedQueryId	Zeichenfolge	Sys_id der zu löschenden Abfrage. Dieser Parameter ist nicht erforderlich, wenn ein Abfragename angegeben wird. Tabelle: Gespeicherte Abfragen [qb_saved_query]
gespeicherterAbfragename	Zeichenfolge	Name der zu löschenden Abfrage. Dieser Parameter ist nicht erforderlich, wenn eine Abfrage-sys_id angegeben wird. Tabelle: Wird im Feld `Name` der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.

Tabelle : 4. Rückgaben
Typ	Beschreibung
Objekt	Details zur gelöschten Abfrage und zu etwaigen Fehlern. `{ "error": "String", "message": "String", "status": "String" }`
<Object>.Fehler	Fehlercode. Wird zurückgegeben, wenn der Löschvorgang fehlschlägt oder ungültige Eingabeparameter angegeben werden. Mögliche Fehler: `ANWENDER_NICHT_AUTORISIERT_AUSGABE` `INVALID_PARAM` `ABFRAGE_LÖSCHEN_FEHLGESCHLAGEN` Datentyp: Zeichenfolge
<Object>.message	Nachricht, die Details über den Erfolg oder Fehler des Löschvorgangs enthält. Mögliche Nachrichten: `Die gespeicherte Abfrage wurde erfolgreich gelöscht` `Anwender ist nicht zum Löschen einer CMDBQueryBuilder-Abfrage berechtigt` `Ungültige Parameter. Geben Sie entweder eine gültige sysId oder den gültigen Namen einer gespeicherten Abfrage an` `Fehler beim Löschen der angegebenen gespeicherten Abfrage` Datentyp: Zeichenfolge
<Object>.status	Statuscode. Wird zurückgegeben, wenn das Update erfolgreich ist. Wert: `Erfolg` Datentyp: Zeichenfolge

In diesem Beispiel wird gezeigt, wie Sie eine gespeicherte Abfrage löschen, indem Sie den Abfragenamen übergeben.

SNC.CMDBQueryBuilderAPI.deleteQuery('', 'CMDBQueryTest1');

Ausgabe:

{
   "message":"Successfully deleted the saved query",
   "status":"success"
}

CMDBQueryBuilderAPI - getSavedQueryExecutionDetails(String savedQueryName, Boolean executeQuery, Number timeout)

Gibt die Ausführungsdetails für eine Configuration Management Database (CMDB) -Abfragegeneratorabfrage zurück.

Optional können Sie die Abfrage ausführen, um aktuelle Ausführungsdetails zurückzugeben.

Wenn bei der Ausführung der Abfrage Zeitüberschreitungen oder Speicherprobleme auftreten, können Sie die Batch-Größe der Abfrage optimieren, um diese Probleme zu beheben. Weitere Informationen finden Sie unter Batchgröße für gespeicherte Abfragen des Abfragegenerators.

Tabelle : 5. Parameter
Name	Typ	Beschreibung
gespeicherterAbfragename	Zeichenfolge	Name der Abfrage, für die Ausführungsdetails abgerufen werden sollen. Tabelle: `Namensfeld` in der Tabelle „Gespeicherte Abfragen“ [qb_saved_query].
executeQuery	Boolean	Optional. Kennzeichnung, die angibt, ob die angegebene Abfrage ausgeführt werden soll. Gültige Werte: „wahr“: Führen Sie die angegebene Abfrage aus, und geben Sie die Ausführungsdetails zurück. „falsch“: Die angegebene Abfrage wird nicht ausgeführt. Gibt die neuesten Ausführungsdetails für die Abfrage zurück. Standardwert: False
Zeitüberschreitung	Nummer	Optional. Ganzzahliger Wert, der die standardmäßige Zeitüberschreitungsgrenze von fünf Minuten für die Abfrageausführung überschreibt. Einheit: Sekunden Standard: Fünf Minuten

Tabelle : 6. Rückgaben
Typ	Beschreibung
Objekt	Details zur Abfrageausführung und zu Fehlern. `{ "error": "String", "message": "String", "query_id": "String", "status": "String", "table_name": "String" }`
<Object>.Fehler	Fehlercode. Wird zurückgegeben, wenn die Ausführung der Abfrage fehlschlägt oder die angegebene Abfrage nicht gefunden wird. Mögliche Fehler: `ABFRAGE_AUSFÜHRUNG_NICHT_GEFUNDEN` `QUERY_NOT_FOUND` `ABFRAGE_AUSFÜHRUNG_FEHLGESCHLAGEN` `ANWENDER_NICHT_AUTORISIERT_AUSGABE` Datentyp: Zeichenfolge
<Object>.message	Meldung, die Details zum Fehlercode enthält. Wird zurückgegeben, wenn die Ausführung der Abfrage fehlschlägt oder die angegebene Abfrage nicht gefunden wird. Mögliche Nachrichten: `Details zur Abfrageausführung nicht gefunden. Führen Sie die Abfrage aus.` `Angegebene gespeicherte Abfrage wurde nicht gefunden. Stellen Sie sicher, dass Sie den Namen einer gespeicherten Abfrage übergeben.` `Ausführung der Abfrage fehlgeschlagen. Verwenden Sie eine gültige Abfrage.` `Anwender ist zum Ausführen einer CMDBQueryBuilder-Abfrage nicht autorisiert.` Datentyp: Zeichenfolge
<Object>.query_id	Sys_id der Abfrageausführung. Datentyp: Zeichenfolge Tabelle: Abfragestatus [qb_query_status]
<Object>.status	Status der Abfrageausführung. COMPLETE: Ausführung ist abgeschlossen. FAILED: Beim Ausführen der Abfrage ist ein Fehler aufgetreten. TIME_out: Zeitüberschreitung bei der Abfrageausführung. MAX_limit: Maximale Anzahl der zurückgegebenen Ergebnisse erreicht. Datentyp: Zeichenfolge
<Object>.table_name	Name der Tabelle, die die Abfrageausführungsdetails enthält. Datentyp: Zeichenfolge

In diesem Beispiel wird gezeigt, wie Sie eine gespeicherte Abfrage ausführen und den Wert für die Zeitüberschreitung bei der Abfrageausführung auf 10 Minuten festlegen.

SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true, 600);

Ausgabe:

{
   "query_id":"024fd53a7773330033b5270bba106141",
   "table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
   "status":COMPLETE
}

CMDBQueryBuilderAPI – saveQuery(String savedQueryName, String queryJson)

Speichert eine Configuration Management Database (CMDB) -Abfragegeneratorabfrage und gibt die sys_id der gespeicherten Abfrage zurück.

Tabelle : 7. Parameter
Name	Typ	Beschreibung
gespeicherterAbfragename	Zeichenfolge	Name, unter dem die Abfrage gespeichert werden soll. Tabelle: Wird im Feld Name der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.
queryJson	Zeichenfolge	JSON, das die Abfrage definiert. Tabelle: Wird im Feld Abfrage der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.

Tabelle : 8. Rückgaben
Typ	Beschreibung
Objekt	Objekt mit Details zur gespeicherten Abfrage und zu Fehlern. `{ "error": "String", "message": "String", "status": "String" }`
<Object>.Fehler	Fehlercode. Wird zurückgegeben, wenn der Speichervorgang fehlschlägt oder ungültige Eingabeparameter angegeben werden. Mögliche Fehler: `ANWENDER_NICHT_AUTORISIERT_AUSGABE` `QUERY_NAME_INVALID` `QUERY_INVALID` `QUERY_EXISTS_ALREADY` `ABFRAGE_SAVE_FEHLGESCHLAGEN` Datentyp: Zeichenfolge
<Object>.message	Nachricht, die Details über den Erfolg oder Fehler des Speichervorgangs enthält. Mögliche Nachrichten: `Die Abfrage mit der Sys-ID wurde erfolgreich gespeichert<sy_id>` `Anwender ist zum Speichern einer CMDBQueryBuilder-Abfrage nicht autorisiert` `Abfragename ist leer. Geben Sie einen Namen an` `QueryJson ist ungültig. Geben Sie eine gültige queryJSON an` `Abfragename wird bereits verwendet, verwenden Sie einen anderen Namen` `Unerwartete Ausnahme beim Speichern der Abfrage` Datentyp: Zeichenfolge
<Object>.status	Statuscode. Wird zurückgegeben, wenn der Speichervorgang erfolgreich ist. Wert: `Erfolg` Datentyp: Zeichenfolge

In diesem Beispiel wird gezeigt, wie der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] eine Abfrage hinzugefügt wird.

var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":337,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Database\",\"unique_id\":\"b640269c1b310210bccf42a3b24bcb36\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/database.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_database\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_database\",\"ci_type_label\":\"Database\",\"sys_id\":\"b640269c1b310210bccf42a3b24bcb36\",\"x\":510,\"y\":340,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"name\":\"Database 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"className\":\"cmdb_ci_database\"}],\"edges\":[{\"id\":\"Server 1_Database 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\",\"1a9cb166f1571100a92eb60da2bce5c5\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1}}";
SNC.CMDBQueryBuilderAPI.saveQuery('CMDBQueryTest1', queryJson);

Ausgabe:

{
   "message":"Successfully saved the query with sysId d93f96981b310210bccf42a3b24bcb41",
   "status":"success"
}

In diesem Beispiel wird ein Fehler angezeigt, wenn eine ungültige JSON-Abfrage angegeben wird.

var queryJson = "Test";
SNC.CMDBQueryBuilderAPI.saveQuery('Test', queryJson);

Ausgabe:

{
   "error":"QUERY_INVALID",
   "message":"QueryJson is invalid. Please provide a valid queryJson"
}

CMDBQueryBuilderAPI – updateQuery(String speicherndQueryId, Zeichenfolge gespeicherterAbfragename, Zeichenfolgen-queryJson)

Aktualisiert das JSON-Objekt für eine Configuration Management Database (CMDB) -Abfragegeneratorabfrage.

Tabelle : 9. Parameter
Name	Typ	Beschreibung
savedQueryId	Zeichenfolge	Sys_id der zu aktualisierenden Abfrage. Dieser Parameter ist nicht erforderlich, wenn ein Abfragename angegeben wird. Tabelle: Gespeicherte Abfragen [qb_saved_query]
gespeicherterAbfragename	Zeichenfolge	Name der zu aktualisierenden Abfrage. Dieser Parameter ist nicht erforderlich, wenn eine Abfrage-sys_id angegeben wird. Tabelle: Wird im Feld `Name` in der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.
queryJson	Zeichenfolge	JSON, mit dem die Abfrage aktualisiert werden soll. Tabelle: Wird im Feld `Abfrage` in der Tabelle „Gespeicherte Abfragen“ [qb_saved_query] gespeichert.

Tabelle : 10. Rückgaben
Typ	Beschreibung
Objekt	Details zur aktualisierten Abfrage und zu etwaigen Fehlern. `{ "error": "String", "message": "String", "status": "String" }`
<Object>.Fehler	Fehlercode. Wird zurückgegeben, wenn die Aktualisierung fehlschlägt oder ungültige Eingabeparameter angegeben werden. Mögliche Fehler: `ANWENDER_NICHT_AUTORISIERT_AUSGABE` `INVALID_PARAM` `QUERY_INVALID` `ABFRAGE_UPDATE_FEHLGESCHLAGEN` `NICHT AUTORISIERTER_BERICHT_SOURCE_ANWENDER` Datentyp: Zeichenfolge
<Object>.message	Nachricht, die Details über den Erfolg oder Fehler des Updates enthält. Mögliche Nachrichten: `Die gespeicherte Abfrage wurde erfolgreich aktualisiert` `Anwender ist nicht zum Aktualisieren einer CMDBQueryBuilder-Abfrage berechtigt` `Ungültige Parameter. Geben Sie entweder eine gültige sysId oder den gültigen Namen einer gespeicherten Abfrage an` `QueryJson ist ungültig. Geben Sie eine gültige queryJSON an` `Fehler beim Aktualisieren der angegebenen gespeicherten Abfrage` `Der Anwender ist nicht zum Aktualisieren der Berichtsquelle einer gespeicherten Abfrage berechtigt` Datentyp: Zeichenfolge
<Object>.status	Statuscode. Wird zurückgegeben, wenn das Update erfolgreich ist. Wert: `Erfolg` Datentyp: Zeichenfolge

In diesem Beispiel wird gezeigt, wie eine gespeicherte Abfrage aktualisiert wird, indem der Abfragename übergeben wird.

var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":336,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Web Server\",\"unique_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/web_server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_web_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_web_server\",\"ci_type_label\":\"Web Server\",\"sys_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"x\":446,\"y\":330,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"name\":\"Web Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"className\":\"cmdb_ci_web_server\"}],\"edges\":[{\"id\":\"Server 1_Web Server 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1,\"cmdb_ci_web_server\":1}}";
gs.log(SNC.CMDBQueryBuilderAPI.updateQuery('', 'CMDBQueryTest1', queryJson));

Ausgabe:

{
   "message":"Successfully updated the saved query",
   "status":"success"
}

In diesem Beispiel wird ein Fehler angezeigt, wenn im Methodenaufruf die Abfrage-Sys-ID und der Name fehlen.

var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":336,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Web Server\",\"unique_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/web_server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_web_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_web_server\",\"ci_type_label\":\"Web Server\",\"sys_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"x\":446,\"y\":330,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"name\":\"Web Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"className\":\"cmdb_ci_web_server\"}],\"edges\":[{\"id\":\"Server 1_Web Server 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1,\"cmdb_ci_web_server\":1}}";
SNC.CMDBQueryBuilderAPI.updateQuery('', '', queryJson);

Ausgabe:

{
   "error":"INVALID_PARAM",
   "message":"Invalid Parameters. Please provide either a valid sysId or a valid name of a saved query"
}