Scan Engine API field reference

reference australia Updated Aug 25, 2026 3 min read finding-resolved-finding-fields.md
Raw file servicenow.com

Field reference for scan status, findings, and resolved findings API responses.

Scan status response fields

The scan status endpoint returns the following fields.

Field Description
batches_complete Number of batches that have finished processing.
end_time Scan end timestamp in format YYYY-MM-DD HH:MM:SS, or null if still running.
number Scan result number, for example SCAN0001234.
progress_percent Scan progress percentage from 0 to 100.
scan_result_sys_id Unique sys_id of the scan result record.
scan_type Type of scan: full_instance_scan, delta_instance_scan, on_demand_instance_scan, application_scan, update_set_scan, or push_commit_scan.
source Originating ServiceNow instance name, or null if not applicable.
start_time Scan start timestamp in format YYYY-MM-DD HH:MM:SS.
status Current scan state: Waiting, Getting Ready, Scanning, Complete, complete_with_errors, Cancelled, Cancellation Requested, No Action Taken, or Queued Scan Cancelled. Keep polling while status is not a terminal state.
summary Available only when status is Complete. Contains: total_findings, total_errors, total_warnings, se_score, total_impact_to_instance, total_technical_debt, and definitions_scanned_for.
total_batches Total number of batches the scan is divided into.
trigger_channel Declared request channel, either API, UI, or Scheduled, captured from the request's source value at trigger time. Use this to determine if a scan was triggered via the API.

Finding and resolved finding fields

The findings and resolved findings endpoints return the following fields. Some fields appear in both response types.

Field Description Finding Resolved Finding
definition Sys_id of the scan definition that raised this finding. ✓ ✓
definition_number Number of that scan definition, for example sn_SE10524. ✓ ✓
exception_state Status of the exception: Requested, Not Yet Requested, Rejected, Approved, No Longer Required, or Not Applicable, or null if none. ✓
exception_sys_id Sys_id of an exception request filed against this finding, if any, or null if none. ✓
finding_count Number of times this condition was detected. ✓
finding_details Human-readable explanation of what the finding is and why it was raised. ✓
finding_policy_status Status of that finding policy: Acceptable as is or Prioritize, or null if none. ✓
finding_policy_sys_id Sys_id of a finding policy applied to this finding, if any, or null if none. ✓
finding_sys_id Sys_id of the original finding that was resolved. ✓
impact_to_instance Severity and impact score for this finding. ✓ ✓
net_new_finding True if this is the first time reported, false if it also appeared in a prior scan. ✓
resolved_on Date the finding was marked as resolved in ISO 8601 format YYYY-MM-DD. ✓
scan_type Type of scan that produced this finding. ✓ ✓
scanned_date Date and time the record was scanned in format YYYY-MM-DD HH:MM:SS. ✓
scanned_record Object containing sys_id and table of the record that was scanned. ✓
scanned_record_display_value Display value of the scanned record, or null if the record no longer exists. ✓
scanned_record_sys_id Sys_id of the record that was scanned, or null if not tied to a specific record. ✓
scanned_record_table Table name of the scanned record. ✓
scanned_scope Object containing sys_id and display_value of the application scope. ✓
scanned_scope_display_value Display name of that application scope, such as Global. ✓
scanned_scope_sys_id Sys_id of the application scope containing the scanned record. ✓
scanned_table Table name of the scanned record. ✓
sys_id Unique identifier of the record. ✓ ✓

Resolved findings query parameters

The resolved findings endpoint accepts the following query parameters.

Parameter Description
definition Filter by definition sys_id or number. Optional.
impact_to_instance Filter by exact impact score. Optional.
limit Page size. Default 100, maximum 1000. Optional.
offset Page offset. Default 0. Optional.
resolved_by Filter by who resolved it, using string name (not a user reference). Optional.
resolved_by_auto_fix Filter by whether the finding was auto-fixed. Use true or false. Optional.
resolved_on_from Resolved on or after. Use ISO 8601 date format YYYY-MM-DD. Optional.
resolved_on_to Resolved on or before. Use ISO 8601 date format YYYY-MM-DD. Optional.
scanned_scope Filter by application scope sys_id. Optional.
scanned_table Filter by scanned table name. Optional.

Parent Topic:Scan Engine reference

Keywords findingsresolved findingsAPIfields
Search documentation
Search document titles and file paths on the australia branch