--- title: CMDBGroupAPI - Scoped description: The CMDBGroupAPI provides methods for performing actions on Configuration Management Database \(CMDB\) groups.Returns all configuration items \(CIs\) for the specified group. The results include all manual CIs and the list of CIs from the query builder's saved query.Returns all configuration items \(CIs\) returned from all saved query builders' query IDs for the specified group.Returns the CMDB group's manual CI list.Returns the query builder's query IDs for the specified CMDB group.Sets the manual CI list for the specified group. The existing manual CI list is overwritten. CI sysIds not found in the cmdb\_ci table are ignored.Sets the saved query ID list for the specified group. The existing query ID list is overwritten. Query sysIds not found in the qb\_saved\_query table are ignored. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/api-reference/server-api-reference/c\_CMDBGroupAPIScoped.html release: australia product: Server API Reference classification: server-api-reference topic_type: concept last_updated: "2026-03-12" reading_time_minutes: 9 breadcrumb: [Server API reference, API reference, API implementation and reference] --- # CMDBGroupAPI- Scoped The CMDBGroupAPI provides methods for performing actions on Configuration Management Database \(CMDB\) groups. This API is a scoped static class. To use this class you must include the `sn_cmdbgroup` namespace identifier before the CMDBGroupAPI object. For example: ``` var response = sn_cmdbgroup.CMDBGroupAPI.getManualCIList(groupSysId, false); ``` To access this API you must have the itil or asset role. **Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md) ## CMDBGroupAPI - getAllCI\(String groupId, Boolean requireCompleteSet, Boolean requireAllQueryNodesCis\) Returns all configuration items \(CIs\) for the specified group. The results include all manual CIs and the list of CIs from the query builder's saved query.
| Name | Type | Description |
|---|---|---|
| groupId | String | Sys\_id of the Configuration Management Database \(CMDB\) group. |
| requireCompleteSet | Boolean | Optional, but must be passed if **requireAllQueryNodesCis** is passed. Flag that indicates whether an empty string is returned if any CIs are filtered out by access control list \(ACL\) restrictions. Valid values: - true: Return empty string. - false: Don't return value. Default: false |
| requireAllQueryNodesCis | Boolean | Optional. Flag that indicates whether to return CIs from all CMDB classes of the query. Valid values: - true: Return CIs from all columns. - false: Only return CIs from the starting node of the query builder query. Default: false |
| Type | Description |
|---|---|
| errors | List of errors for a failed operation.Data type: Array ``` "errors": [ { "message": "String", "error": "String" } ] ``` |
| errors.error | Error name.Possible values: - 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 Data type: String |
| errors.message | Brief description of the error message.Data type: String |
| idList | List of CMDB CI sys\_ids.Data type: Array |
| partialCIListDueToACLFlag | Flag that indicates if the list of returned CIs is incomplete due to ACL restrictions.**Note:** This is not considered an error condition, and no corresponding error information is returned. Data type: Boolean Valid values: - true: **idList** is incomplete. - false: **idList** is complete. |
| result | Flag that indicates whether the method completed successfully.Possible values: - true: Success - false: Error |
| Name | Type | Description |
|---|---|---|
| groupId | String | Sys\_id of the Configuration Management Database \(CMDB\) group. |
| requireCompleteSet | Boolean | Optional, but must be passed if **requireAllQueryNodesCis** is passed. Flag that indicates whether an empty string is returned if any CIs are filtered out by access control list \(ACL\) restrictions. Valid values: - true: Return empty string. - false: Don't return value. Default: false |
| requireAllQueryNodesCis | Boolean | Optional. Flag that indicates whether to return CIs from all CMDB classes of the query. Valid values: - true: Return CIs from all columns. - false: Only return CIs from the starting node of the query builder query. Default: false |
| Type | Description |
|---|---|
| errors | List of errors for a failed operation.Data type: Array ``` "errors": [ { "message": "String", "error": "String" } ] ``` |
| errors.error | Error name.Possible values: - 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 Data type: String |
| errors.message | Brief description of the error message.Data type: String |
| idList | List of CMDB CI sys\_ids.Data type: Array |
| partialCIListDueToACLFlag | Flag that indicates if the list of returned CIs is incomplete due to ACL restrictions.**Note:** This is not considered an error condition, and no corresponding error information is returned. Data type: Boolean Valid values: - true: **idList** is incomplete. - false: **idList** is complete. |
| result | Flag that indicates whether the method completed successfully.Possible values: - true: Success - false: Error |
| Type | Description |
|---|---|
| String | A JSON formated string in the 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'] } ``` Where - result - a boolean flag. When true the method was successful. - errors - a list of errors with a message and error code. - partialCIListDueToACLFlag - a Boolean flag. When true, the idList is incomplete due to an ACL restriction. When false, the idList is complete. - idList - an array of cmdb\_ci sys\_ids When not successful, returns one of the errors 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 |
| Type | Description |
|---|---|
| String | A JSON formated string in the 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'] } ``` Where - result - a boolean flag. When true the method was successful. - errors - a list of errors with a message and error code. - partialCIListDueToACLFlag - a Boolean flag. When true, the idList is incomplete due to an ACL restriction. When false, the idList is complete. - idList - an array of cmdb\_ci sys\_ids When not successful, returns one of the errors 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 |
| Type | Description |
|---|---|
| String | A JSON formated string in the 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'] } ``` Where - result - a boolean flag. When true the method was successful. - errors - a list of errors with a message and error code. - partialCIListDueToACLFlag - a Boolean flag. When true, the idList is incomplete due to an ACL restriction. When false, the idList is complete. - idList - an array of cmdb\_ci sys\_ids When not successful, returns one of the errors 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 |
| Type | Description |
|---|---|
| String | A JSON formated string in the 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'] } ``` Where - result - a boolean flag. When true the method was successful. - errors - a list of errors with a message and error code. - partialCIListDueToACLFlag - a Boolean flag. When true, the idList is incomplete due to an ACL restriction. When false, the idList is complete. - idList - an array of cmdb\_ci sys\_ids When not successful, returns one of the errors 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 |