CMDBGroupAPI – Umfang

Die CMDBGroupAPI Stellt Methoden zum Ausführen von Aktionen für bereit Configuration Management Database (CMDB) Gruppen.

Diese API ist eine bereichsbezogene statische Klasse. Um diese Klasse zu verwenden, müssen Sie einschließen sn_cmdbGroup Namespace-Bezeichner vor dem CMDBGroupAPI-Objekt. Zum Beispiel:

var response = sn_cmdbgroup.CMDBGroupAPI.getManualCIList(groupSysId, false);

Um auf diese API zuzugreifen, müssen Sie über die Rolle itil oder Asset verfügen.

CMDBGroupAPI – getAllCI(String groupId, Boolean requirements CompleteSet, Boolean requirements AllQueryNodesCis)

Gibt alle Konfigurationselemente (Configuration Items, CIs) für die angegebene Gruppe zurück. Die Ergebnisse umfassen alle manuellen CIs und die Liste der CIs aus der gespeicherten Abfrage des Abfragegenerators.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	SYS_ID der CMDB-Gruppe (Configuration Management Database).
requireCompleteSet	Boolean	Optional, muss aber übergeben werden, wenn requireAllQueryNodesCisIst bestanden. Kennzeichnung, die angibt, ob eine leere Zeichenfolge zurückgegeben wird, wenn CIs durch Zugriffssteuerungslistenbeschränkungen (ACL) herausgefiltert werden. Gültige Werte: Wahr: Leere Zeichenfolge zurückgeben. Falsch: Wert nicht zurückgeben. Standardwert: false
AnforderungAllQueryNodesCis	Boolean	Optional. Kennzeichnung, die angibt, ob CIs aus allen CMDB-Klassen der Abfrage zurückgegeben werden sollen. Gültige Werte: Wahr: CIs aus allen Spalten zurückgeben. Falsch: Gibt nur CIs vom Startknoten der Abfrage des Abfragegenerators zurück. Standardwert: false

Tabelle : 2. Rückgaben

Typ	Beschreibung
Fehler	Liste der Fehler für einen fehlgeschlagenen Vorgang. Datentyp: Array "errors": [ { "message": "String", "error": "String" } ]
Fehler.Fehler	Fehlername. Mögliche Werte: GROUP_SYS_ID_IS_NOT_FOUND GROUP_SYS_ID_IST_LEER FAIL_TO_INSERT_GROUP_CI_PAIR FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR CI_CAN_NOT_FOUND SAVED_QUERY_ID_NOT_FOUND ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY GROUP_API_TIMEOUT EXCEPTION_FROM_EXECUTE_QUERY SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT Datentyp: Zeichenfolge
Fehler.Nachricht	Kurze Beschreibung der Fehlermeldung. Datentyp: Zeichenfolge
IdList	Liste der CMDB-CI-sys_IDs. Datentyp: Array
PartialCIListDueToACLFlag	Kennzeichnung, die angibt, ob die Liste der zurückgegebenen CIs aufgrund von ACL-Einschränkungen unvollständig ist. Hinweis: Dies wird nicht als Fehlerbedingung betrachtet, und es werden keine entsprechenden Fehlerinformationen zurückgegeben. Datentyp: Boolesch Gültige Werte: Wahr: idListIst unvollständig. Falsch: idListIst abgeschlossen.
Ergebnis	Kennzeichnung, die angibt, ob die Methode erfolgreich abgeschlossen wurde. Mögliche Werte: Wahr: Erfolg Falsch: Fehler

// Script example: 
var getAllCIFunc = function(groupSysId) {
  var parser = new JSONParser();
  var response = sn_cmdbgroup.CMDBGroupAPI.getAllCI(groupSysId, false);
  var parsed = parser.parse(response);
  if (parsed.result) {
    gs.info("succeed to retrieve ci list: " + parsed.idList);
  } else {
    gs.info("fail to retrieve list, errors: " + JSON.stringify(parsed.errors));
  }
}
var groupExists = "d0d2d25113152200eef2dd828144b0e4";
var groupContainsInvalidSavedQuery = "e685a2c3d7012200de92a5f75e610387";
getAllCIFunc(groupExists);
getAllCIFunc(groupContainsInvalidSavedQuery);

Ausgabe:

// Successful response
{
  'result':true, 
  'partialCIListDueToACLFlag': false,
  'idList':[
    '3a5dd3dbc0a8ce0100655f1ec66ed42c',
    '6b43105c37301000deeabfc8bcbe5db2'
  ] 
}

// Error response
{ 
  'result':false, 
  'errors':[ 
    {
      'message':'Group does not exist',
      'error':'GROUP_SYS_ID_IS_NOT_FOUND'
    } 
  ], 
  'partialCIListDueToACLFlag':false,
  'idList':[] 
}

CMDBGroupAPI – getAllCIFromQueryBuilder(String groupId, Boolean requirements CompleteSet, Boolean requirements AllQueryNodesCis)

Gibt alle Konfigurationselemente (Configuration Items, CIs) zurück, die von den Abfrage-IDs aller gespeicherten Abfragegeneratoren für die angegebene Gruppe zurückgegeben werden.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	SYS_ID der CMDB-Gruppe (Configuration Management Database).
requireCompleteSet	Boolean	Optional, muss aber übergeben werden, wenn requireAllQueryNodesCisIst bestanden. Kennzeichnung, die angibt, ob eine leere Zeichenfolge zurückgegeben wird, wenn CIs durch Zugriffssteuerungslistenbeschränkungen (ACL) herausgefiltert werden. Gültige Werte: Wahr: Leere Zeichenfolge zurückgeben. Falsch: Wert nicht zurückgeben. Standardwert: false
AnforderungAllQueryNodesCis	Boolean	Optional. Kennzeichnung, die angibt, ob CIs aus allen CMDB-Klassen der Abfrage zurückgegeben werden sollen. Gültige Werte: Wahr: CIs aus allen Spalten zurückgeben. Falsch: Gibt nur CIs vom Startknoten der Abfrage des Abfragegenerators zurück. Standardwert: false

Tabelle : 4. Rückgaben

Typ	Beschreibung
Fehler	Liste der Fehler für einen fehlgeschlagenen Vorgang. Datentyp: Array "errors": [ { "message": "String", "error": "String" } ]
Fehler.Fehler	Fehlername. Mögliche Werte: GROUP_SYS_ID_IS_NOT_FOUND GROUP_SYS_ID_IST_LEER FAIL_TO_INSERT_GROUP_CI_PAIR FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR CI_CAN_NOT_FOUND SAVED_QUERY_ID_NOT_FOUND ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY GROUP_API_TIMEOUT EXCEPTION_FROM_EXECUTE_QUERY SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT Datentyp: Zeichenfolge
Fehler.Nachricht	Kurze Beschreibung der Fehlermeldung. Datentyp: Zeichenfolge
IdList	Liste der CMDB-CI-sys_IDs. Datentyp: Array
PartialCIListDueToACLFlag	Kennzeichnung, die angibt, ob die Liste der zurückgegebenen CIs aufgrund von ACL-Einschränkungen unvollständig ist. Hinweis: Dies wird nicht als Fehlerbedingung betrachtet, und es werden keine entsprechenden Fehlerinformationen zurückgegeben. Datentyp: Boolesch Gültige Werte: Wahr: idListIst unvollständig. Falsch: idListIst abgeschlossen.
Ergebnis	Kennzeichnung, die angibt, ob die Methode erfolgreich abgeschlossen wurde. Mögliche Werte: Wahr: Erfolg Falsch: Fehler

// Script example:
var getAllCIFromQueryBuilderFunc = function(groupSysId) {
  var parser = new JSONParser();
  var response = sn_cmdbgroup.CMDBGroupAPI.getAllCIFromQueryBuilder(groupSysId, false);
  var parsed = parser.parse(response);
  if (parsed.result) {
    gs.info("succeed to retrieve ci list: " + parsed.idList);
  } else {
    gs.info("fail to retrieve list, errors: " + JSON.stringify(parsed.errors));
  }
}
var groupExists = "d0d2d25113152200eef2dd828144b0e4";
var groupContainsInvalidSavedQuery = "e685a2c3d7012200de92a5f75e610387";
getAllCIFromQueryBuilderFunc(groupExists);
getAllCIFromQueryBuilderFunc(groupContainsInvalidSavedQuery);

Ausgabe:

// Successful response
{
  'result':true, 
  'partialCIListDueToACLFlag': false,
  'idList':[
    '3a5dd3dbc0a8ce0100655f1ec66ed42c',
    '6b43105c37301000deeabfc8bcbe5db2'
  ] 
}

// Error response
{ 
  'result':false, 
  'errors':[ 
    {'message':'Group does not exist',
    'error':'GROUP_SYS_ID_IS_NOT_FOUND'} 
  ], 
  'partialCIListDueToACLFlag':false,
  'idList':[] 
}

CMDBGroupAPI – getManualCIList(String groupId, Boolean requireCompleteSet)

Gibt die manuelle CI-Liste der CMDB-Gruppe zurück.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	Die sysId der CMDB-Gruppe.
requireCompleteSet	Boolean	Bei „true“ wird eine Fehlerzeichenfolge zurückgegeben, wenn CIs durch ACL-Beschränkungen herausgefiltert werden.

Tabelle : 6. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Eine JSON-formatierte Zeichenfolge im Format { 'result':false, 'errors':[ {'message':'Group does not exist', 'error':'GROUP_SYS_ID_IS_NOT_FOUND'}, { } // another error if it exists ], 'partialCIListDueToACLFlag':false, 'idList':['sys_id_1', 'sys_id2'] } Wobei result – eine boolean Kennzeichnung. Wenn „true“, war die Methode erfolgreich. errors – eine Liste von Fehlern mit einer Meldung und einem Fehlercode. partialCIListDueToACLFlag – eine boolean Kennzeichnung. Bei „true“ ist die idList aufgrund einer ACL-Beschränkung unvollständig. Bei „false“ ist die idList vollständig. idList – ein Array von cmdb_ci-sys_ids Wenn nicht erfolgreich, wird einer der Fehler GROUP_SYS_ID_IS_NOT_FOUND, GROUP_SYS_ID_IS_EMPTY, FAIL_TO_INSERT_GROUP_CI_PAIR, FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR, CI_CAN_NOT_FOUND, SAVED_QUERY_ID_NOT_FOUND, ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY, TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY, NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY, MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY, GROUP_API_TIMEOUT, EXCEPTION_FROM_EXECUTE_QUERY, SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT ausgegeben.

// Script example for requireCompleteSet being false:
    var getManualCIList = function(groupSysId) {
    var parser = new JSONParser();
    var response = sn_cmdbgroup.CMDBGroupAPI.getManualCIList(groupSysId, false);
    var parsed = parser.parse(response);
    if (parsed.result) {
        gs.info("succeed to retrieve ci list: " + parsed.idList);
    } else {
        gs.info("fail to retrieve list, errors: " + JSON.stringify(parsed.errors));
    }
}
// create a group in cmdb_group, and add CIs to this group in Edit Manual CI form
var groupExists = "d0d2d25113152200eef2dd828144b0e4";
// use a non-exist group
var groupDoesNotExists = "d0d2d25113152200eef2dd828144b0e4111";
getManualCIList(groupExists);
getManualCIList(groupDoesNotExists);
 

Ausgabe: (Zeilenumbrüche zur Formatierung hinzugefügt.)

succeed to retrieve ci 
list: 6b43105c37301000deeabfc8bcbe5db2,2dfd7c8437201000deeabfc8bcbe5d56
fail to retrieve list, errors: 
[{"message":"Group does not exist","error":"GROUP_SYS_ID_IS_NOT_FOUND"}]

// Script example for requireCompleteSet being true
    var getManualCIList = function(groupSysId) {
    var parser = new JSONParser();
    var response = sn_cmdbgroup.CMDBGroupAPI.getManualCIList(groupSysId, true);
    var parsed = parser.parse(response);
    if (parsed.result) {
        gs.info("succeed to retrieve ci list: " + parsed.idList);
    } else {
        gs.info("fail to retrieve list, errors: " + JSON.stringify(parsed.errors));
    }
}
// create a group in cmdb_group, and add CIs to this group in Edit Manual CI form
var groupExists = "d0d2d25113152200eef2dd828144b0e4";
getManualCIList(groupExists);

Ausgabe: (Zeilenumbrüche zur Formatierung hinzugefügt.)

fail to retrieve list, errors: 
[{"message":"Some CI(s) not visible due to security constraint",
"error":"SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT"}]

CMDBGroupAPI – getSavedQueryIdList(String groupId, Boolean requireCompleteSet)

Gibt die Abfrage-IDs des Abfragegenerators für die angegebene CMDB-Gruppe zurück.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	Die sysId der CMDB-Gruppe.
requireCompleteSet	Boolean	Bei „true“ wird eine leere Zeichenfolge zurückgegeben, wenn CIs durch ACL-Beschränkungen herausgefiltert werden.

Tabelle : 8. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Eine JSON-formatierte Zeichenfolge im Format { 'result':false, 'errors':[ {'message':'Group does not exist', 'error':'GROUP_SYS_ID_IS_NOT_FOUND'}, { } // another error if it exists ], 'partialCIListDueToACLFlag':false, 'idList':['sys_id_1', 'sys_id2'] } Wobei result – eine boolean Kennzeichnung. Wenn „true“, war die Methode erfolgreich. errors – eine Liste von Fehlern mit einer Meldung und einem Fehlercode. partialCIListDueToACLFlag – eine boolean Kennzeichnung. Bei „true“ ist die idList aufgrund einer ACL-Beschränkung unvollständig. Bei „false“ ist die idList vollständig. idList – ein Array von cmdb_ci-sys_ids Wenn nicht erfolgreich, wird einer der Fehler GROUP_SYS_ID_IS_NOT_FOUND, GROUP_SYS_ID_IS_EMPTY, FAIL_TO_INSERT_GROUP_CI_PAIR, FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR, CI_CAN_NOT_FOUND, SAVED_QUERY_ID_NOT_FOUND, ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY, TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY, NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY, MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY, GROUP_API_TIMEOUT, EXCEPTION_FROM_EXECUTE_QUERY, SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT ausgegeben.

// Script example:
var getSavedQueryIdList = function(groupSysId) {
    var parser = new JSONParser();
    var response = sn_cmdbgroup.CMDBGroupAPI.getSavedQueryIdList(groupSysId, false);
    var parsed = parser.parse(response);
    if (parsed.result) {
        gs.info("succeed to retrieve saved query id list: " + parsed.idList);
    } else {
        gs.info("fail to retrieve list, errors: " + JSON.stringify(parsed.errors));
    }
}
var groupExists = "d0d2d25113152200eef2dd828144b0e4";
var groupDoesNotExists = "d0d2d25113152200eef2dd828144b0e4111";
getSavedQueryIdList(groupExists);
getSavedQueryIdList(groupDoesNotExists);

Ausgabe: (Zeilenumbrüche zur Formatierung hinzugefügt.)

succeed to retrieve saved query id list: 5d498532d7c12200de92a5f75e6103ce
fail to retrieve list, errors:
 [{"message":"Group does not exist","error":"GROUP_SYS_ID_IS_NOT_FOUND"}]

CMDBGroupAPI – setManualCIList(String groupId, String ciSysIds)

Legt die manuelle CI-Liste für die angegebene Gruppe fest. Die vorhandene manuelle CI-Liste wird überschrieben. CI-System-IDs, die nicht in der Tabelle cmdb_ci enthalten sind, werden ignoriert.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	Die sysId der CMDB-Gruppe.
ciSysIds	Zeichenfolge	Durch Kommas getrennte Liste von CI-sysIds

Tabelle : 10. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Eine JSON-formatierte Zeichenfolge im Format { 'result':false, 'errors':[ {'message':'Group does not exist', 'error':'GROUP_SYS_ID_IS_NOT_FOUND'}, { } // another error if it exists ], 'partialCIListDueToACLFlag':false, 'idList':['sys_id_1', 'sys_id2'] } Wobei result – eine boolean Kennzeichnung. Wenn „true“, war die Methode erfolgreich. errors – eine Liste von Fehlern mit einer Meldung und einem Fehlercode. partialCIListDueToACLFlag – eine boolean Kennzeichnung. Bei „true“ ist die idList aufgrund einer ACL-Beschränkung unvollständig. Bei „false“ ist die idList vollständig. idList – ein Array von cmdb_ci-sys_ids Wenn nicht erfolgreich, wird einer der Fehler GROUP_SYS_ID_IS_NOT_FOUND, GROUP_SYS_ID_IS_EMPTY, FAIL_TO_INSERT_GROUP_CI_PAIR, FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR, CI_CAN_NOT_FOUND, SAVED_QUERY_ID_NOT_FOUND, ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY, TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY, NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY, MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY, GROUP_API_TIMEOUT, EXCEPTION_FROM_EXECUTE_QUERY, SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT ausgegeben.

// Script example:
var setManualCIListFunc = function(groupSysId, manualCIList) {
    var parser = new JSONParser();
    var response = sn_cmdbgroup.CMDBGroupAPI.setManualCIList(groupSysId, manualCIList);
    var parsed = parser.parse(response);
    if (parsed.result) {
        gs.info("succeed to set manual ci list");
    } else {
        gs.info("fail to set manual ci list, errors: " + JSON.stringify(parsed.errors));
    }
}
var group = "d0d2d25113152200eef2dd828144b0e4";
var groupDoesNotExist = "1234";
var manualCIList = "b4fd7c8437201000deeabfc8bcbe5dc1, affd3c8437201000deeabfc8bcbe5dc3";
setManualCIListFunc(group, manualCIList);
setManualCIListFunc(groupDoesNotExist, manualCIList);

Ausgabe: (Zeilenumbrüche zur Formatierung hinzugefügt.)

succeed to set manual ci list
fail to set manual ci list, errors: [{"message":"Group does not exist","error":
"GROUP_SYS_ID_IS_NOT_FOUND"}]

CMDBGroupAPI – setSavedQueryIdList(String groupId, String queryIds)

Legt die gespeicherte Abfrage-ID-Liste für die angegebene Gruppe fest. Die vorhandene Abfrage-ID-Liste wird überschrieben. Abfrage-sysIds, die nicht in der Tabelle qb_saved_query gefunden wurden, werden ignoriert.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
groupId	Zeichenfolge	Die sysId der CMDB-Gruppe.
queryIds	Zeichenfolge	Durch Kommas getrennte Listen gespeicherter Abfrage-sysIds.

Tabelle : 12. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Eine JSON-formatierte Zeichenfolge im Format { 'result':false, 'errors':[ {'message':'Group does not exist', 'error':'GROUP_SYS_ID_IS_NOT_FOUND'}, { } // another error if it exists ], 'partialCIListDueToACLFlag':false, 'idList':['sys_id_1', 'sys_id2'] } Wobei result – eine boolean Kennzeichnung. Wenn „true“, war die Methode erfolgreich. errors – eine Liste von Fehlern mit einer Meldung und einem Fehlercode. partialCIListDueToACLFlag – eine boolean Kennzeichnung. Bei „true“ ist die idList aufgrund einer ACL-Beschränkung unvollständig. Bei „false“ ist die idList vollständig. idList – ein Array von cmdb_ci-sys_ids Wenn nicht erfolgreich, wird einer der Fehler GROUP_SYS_ID_IS_NOT_FOUND, GROUP_SYS_ID_IS_EMPTY, FAIL_TO_INSERT_GROUP_CI_PAIR, FAIL_TO_INSERT_GROUP_QUERY_ID_PAIR, CI_CAN_NOT_FOUND, SAVED_QUERY_ID_NOT_FOUND, ERROR_DURING_QUERY_BUILDER_PROCESS_QUERY, TIMEOUT_DURING_QUERY_BUILDER_PROCESS_QUERY, NOT_COMPLETE_DURING_QUERY_BUILDER_PROCESS_QUERY, MAX_LIMIT_DURING_QUERY_BUILDER_PROCESS_QUERY, GROUP_API_TIMEOUT, EXCEPTION_FROM_EXECUTE_QUERY, SOME_CI_NOT_VISIBLE_DUE_TO_SECURITY_CONSTRAINT ausgegeben.

// Script example:
var setSavedQueryIdListFunc = function(groupSysId, queryIdList) {
    var parser = new JSONParser();
    var response = sn_cmdbgroup.CMDBGroupAPI.setSavedQueryIdList(groupSysId, queryIdList);
    var parsed = parser.parse(response);
    if (parsed.result) {
        gs.info("succeed to set saved query id list");
    } else {
        gs.info("fail to set saved query id list, errors: " + JSON.stringify(parsed.errors));
    }
}
var group = "d0d2d25113152200eef2dd828144b0e4";
var savedQueryBuilderIdList = "394585fed7812200de92a5f75e6103e8";
var savedQueryBuilderIdNotExistList = "b4fd7c8437201000deeabfc8bcbe5dc1,
   affd3c8437201000deeabfc8bcbe5dc3";
 
setSavedQueryIdListFunc(group, savedQueryBuilderIdList);
setSavedQueryIdListFunc(group, savedQueryBuilderIdNotExistList);

Ausgabe: (Zeilenumbrüche zur Formatierung hinzugefügt.)

succeed to set saved query id list
fail to set saved query id list, errors: [{"message":
"Saved query id(b4fd7c8437201000deeabfc8bcbe5dc1) is not found for 
group(d0d2d25113152200eef2dd828144b0e4)","error":
"SAVED_QUERY_ID_NOT_FOUND"},{"message":
"Saved query id(affd3c8437201000deeabfc8bcbe5dc3) is not found for 
group(d0d2d25113152200eef2dd828144b0e4)","error":"SAVED_QUERY_ID_NOT_FOUND"}]