ReportCiStatusOutputJS - Scoped

concept brazil Updated Sep 10, 2026 2 min read c_ReportCiStatusOutputJSScopedAPI.md
Raw file servicenow.com

The ReportCiStatusOutputJS API provides methods that return specific object properties for the DiscoveryAPI reportCiIpAddressStatus method and then converts the information into a JSON string.

This class runs is in the sn_discovery namespace.

Parent Topic:Server API reference

ReportCiStatusOutputJS - getCiOperationStatus()

Returns the state of the scanned CI.

This is a calculated field based on the last_state field in discovery_device_history table and the state field in the discovery_status table.

Name Type Description
None

Type

Description

string

The three possible states returned by this method are:- Processing: Discovery is still processing the request.

  • Successful: A CI was created or updated.
  • NotSuccessful: A CI was not created or updated, and the Discovery status was Completed or Cancelled.
``` var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus); gs.info("ipResultObj(CiOperationStatus): " + ipResultObj.getCiOperationStatus());
Text
## ReportCiStatusOutputJS - getCmdbCI\(\)
Returns the value in the cmdb\_ci field from the discovery\_device\_history table for the CI being scanned.
|Name|Type|Description||----|----|-----------||None| | |
|Type|Description||----|-----------||string|Sys\_id of the CI created or updated. This value can be null in the case of intermediate results before a CI is created.|

var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus); gs.info("ipResultObj(cmdb): " + ipResultObj.getCmdbCI());

Text
## ReportCiStatusOutputJS - getDiscoveryState\(\)
Returns the value from the **State** field in the Discovery Status \[discovery\_status\] table.
The values returned by this method are used to calculate the value returned by the [getCiOperationStatus\(\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/server-api-reference/c_ReportCiStatusOutputJSScopedAPI.md) method
|Name|Type|Description||----|----|-----------||None| | |
<table id="table_otv_blb_scb" class="returns"><thead><tr><th>
Type
</th><th>
Description
</th></tr></thead><tbody><tr><td>
string
</td><td>
The possible states returned by this method are:-   Starting-   Active-   Complete-   Cancelled
</td></tr></tbody></table>```var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);gs.info("ipResultObj(discoveryState): " + ipResultObj.getDiscoveryState());

ReportCiStatusOutputJS - getIpAddress()

Returns the value from the source field in the discovery_device_history table for the CI being scanned.

Name Type Description
None
Type Description
string The IP address of the CI being scanned.
JavaScript
var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);gs.info("ipResultObj(IpAddress): " + ipResultObj.getIpAddress());

ReportCiStatusOutputJS - getIssues()

Returns the value from the issues field in the discovery_device_history table for the CI being scanned.

Name Type Description
None
Type Description
integer Number of issues in this Discovery for this CI.
JavaScript
var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);gs.info("ipResultObj(issues): " + ipResultObj.getIssues());

Returns the value from the issues_link field in the discovery_device_history table for the CI being scanned.

Name Type Description
None

Type

Description

string

The issues_link field from the discovery_device_history table.This value may be null or an anchor tag defining a hyperlink to a page that provides the list of issues associated with the Discovery Status and CI (IP address).

``` var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus); gs.info("ipResultObj(issues_link): " + ipResultObj.getIssuesLink()); ```

ReportCiStatusOutputJS - toJson()

Serializes the ReportCiStatusOutputJS object.

This method throws the IllegalArgumentException exception, Cannot serialize object, e when the method is unable to serialize the object. The e is the exception object, which provides the exception message and trace.

Name Type Description
None
Type Description
string Serialized instance of the ReportCiStatusOutputJS object into a JSON string.
JavaScript
var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);gs.info("ipResultObj(json): " + ipResultObj.toJson());
Search documentation
Search document titles and file paths on the brazil branch