Scan Details Report

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves detailed patch scan information for managed systems.

Request URL

https://{serverurl}/dcapi/patch/reports/scanDetails Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/patchReports.v1+jsonapplication/patchReports.v1+jsonCopied!

- Query Parameters

pageLimitintegerOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

searchColumnstringOptional

Name of the column in which the search value needs to be looked up. Use together with searchValue.

searchValuestringOptional

Text to look up in the column given in searchColumn. Use together with searchColumn.

branchOfficestringOptional

Returns only the systems that belong to the given remote office (branch office). Provide the remote office name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the remote office names from Get Remote Offices api

platformIdlongOptional

Returns only the records of the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux.

healthStatusIdlongOptional

Returns only the systems with the given patch health (vulnerability) status. Accepted values: 0 - Not Available, 1 - Healthy, 2 - Vulnerable, 3 - Highly Vulnerable.

liveStatusIdlongOptional

Returns only the systems with the given agent live status. Accepted values: 1 - Live, 2 - Down, 3 - Unknown.

installationStatuslongOptional

Returns only the entries with the given installation status.

cgIdlongOptional

Unique identifier of the custom group whose systems need to be considered. Get the custom group ID from Get Custom Groups api

resourceIdlongOptional

Unique identifier of the system (resource) to which the data needs to be filtered. Get the value from Get All Systems

scanStatuslongOptional

Returns only the systems with the given patch scan status. Accepted values: 226 - Failed, 227 - In Progress, 228 - Success, 229 - Not Done.

domainstringOptional

Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from Get Domains api

customGroupFilterstringOptional

Returns only the systems that are members of the given custom group. Provide the custom group name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the custom group names from Get Custom Groups api

kbnumberlongOptional

Returns only the patches whose KB (knowledge base) article number contains the given value. For example, 5031356. Partial values are matched.

isWebViewstringOptional

Indicates whether the response is requested for the web console. Set to True to get the response in the format used by the web console; leave empty for the default API response.

skipColumnsstringOptional

Comma-separated list of column names that should be left out of the response, to get a lighter response with only the columns you need.

- Request Body

application/json
JSON Object
Hide Sub-Attributes
dcViewFilterIDintegerOptional

View filter ID for saved custom view

criteriaJSONJSON ArrayOptional

Array of filter criteria for the report view

Show Sub-Attributes
JSON Object
Show Sub-Attributes
columnIDlongMandatory

Column identifier for the filter criterion

searchValueJSON ArrayOptional

Array of search values for the filter

Show Sub-Attributes
string
comparatorstringMandatory

Comparison operator (e.g., equals, contains, greater_than)

customComparatorstringOptional

Custom comparator override for special filter logic

logicalOperatorstringMandatory

Logical operator to combine with next criterion (AND/OR)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/scanDetails \
  --header 'Accept: application/patchReports.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "dcViewFilterID": 0,
    "criteriaJSON": [
      {
        "columnID": 0,
        "searchValue": [
          "string"
        ],
        "comparator": "string",
        "customComparator": "string",
        "logicalOperator": "string"
      }
    ]
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
metadataJSON Object

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of scan detail entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resource_name_transformstring

Transformed resource/computer name

agent_version_transformstring

Transformed agent version string

oslanguage_languageidstring

OS language ID

resource_health_statusstring

Resource health status code, or null

branch_office_idstring

Branch office ID

os_languagestring

OS language code

agent_installed_onstring

Agent installation time in epoch milliseconds

os_platform_namestring

OS platform name (Windows, Mac, Linux)

owner_transformstring

Transformed owner name, or --

service_packstring

OS service pack or version details

os_name_transformstring

Transformed OS name

os_language_abbrstring

OS language abbreviation (e.g., en, fr)

branchofficedetails_branch_office_idstring

Branch office details ID

domain_netbios_name_transformstring

Transformed domain NetBIOS name

os_platform_idstring

OS platform ID

os_platform_name_transformstring

Transformed OS platform name

pmreshealthstatus_resource_idstring

PM resource health status resource ID, or null

location_transformstring

Transformed location, or --

scan_remarksstring

Scan remarks i18n key

branch_office_name_transformstring

Transformed branch office name

i18n_transformstring

Transformed internationalization language name

agent_last_contact_time_transformstring

Formatted agent last contact time

os_platformstring

OS platform code

agent_last_ds_contact_timestring

Agent last distribution server contact time in epoch milliseconds

agent_logged_on_usersstring

Currently logged on users

osflavor_idstring

OS flavor ID

i18nstring

Internationalization language key

search_tagstring

Search tag, or --

status_labelstring

Installation status label key

error_kb_urlstring

Error KB article URL, or null

owner_email_idstring

Owner email address, or --

agent_installed_dir_transformstring

Transformed agent installation directory path

installation_statusstring

Installation status code

last_scan_time_transformstring

Formatted last scan time

friendly_name_transformstring

Transformed friendly name

scan_remarks_transformstring

Transformed scan remarks text

last_successful_scanstring

Last successful scan time in epoch milliseconds

branchmemberresourcerel_resource_idstring

Branch member resource relation ID

computer_status_update_timestring

Computer status update time in epoch milliseconds

branch_office_namestring

Branch office name

processor_architecturestring

Processor architecture code

agent_last_contact_timestring

Agent last contact time in epoch milliseconds

descriptionstring

Computer description, or null

owner_email_id_transformstring

Transformed owner email, or --

domain_netbios_namestring

Domain NetBIOS name

status_label_transformstring

Transformed installation status label

patch_status_labelstring

Patch scan status label key

ip_address_transformstring

Transformed IP address

search_tag_transformstring

Transformed search tag, or --

agent_installed_on_transformstring

Formatted agent installation date

agent_last_bootup_time_transformstring

Formatted agent last bootup time

agent_installed_dirstring

Agent installation directory path

mac_addressstring

MAC address(es), comma-separated

agent_last_ds_contact_time_transformstring

Formatted last DS contact time, or --

scan_remarks_argsstring

Scan remarks arguments, or null

patch_status_label_transformstring

Transformed patch scan status label

patchclientscanerror_resource_idstring

Patch client scan error resource ID, or null

ownerstring

Owner name, or --

patch_scan_error_codestring

Patch scan error code, or null

friendly_namestring

Friendly name of the resource

scan_statusstring

Scan status code

description_transformstring

Transformed description, or --

last_successful_scan_transformstring

Formatted last successful scan time

patch_status_imagestring

Patch status image path

last_sync_timestring

Last sync time in epoch milliseconds

agent_logged_on_users_transformstring

Transformed logged on users

ip_addressstring

IP address(es), comma-separated

service_pack_transformstring

Transformed service pack/OS version

patchmgmtosinfo_resource_idstring

Patch management OS info resource ID

agent_versionstring

Agent version string

mac_address_transformstring

Transformed MAC address

resource_health_status_transformstring

Transformed resource health status, or --

agent_last_bootup_timestring

Agent last bootup time in epoch milliseconds

resource_idstring

Unique resource identifier

os_namestring

Full OS name

locationstring

Location of the system, or --

computer_live_statusstring

Computer live status code

resource_namestring

Resource name

last_scan_timestring

Last scan time in epoch milliseconds

customer_idstring

Customer ID

totalPagesstring

Total number of pages available

statusstring

Operation result: success

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Sample Response: HTTP 200

Detailed scan report

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "DESKTOP-3MGS2V0",
        "agent_version_transform": "11.5.2616.01.W",
        "oslanguage_languageid": "1",
        "resource_health_status": null,
        "branch_office_id": "1",
        "os_language": "1",
        "agent_installed_on": "1778777427871",
        "os_platform_name": "Windows",
        "owner_transform": "--",
        "service_pack": "Windows 11 Version 25H2 (x64)",
        "os_name_transform": "Windows 10 Education (x64)",
        "os_language_abbr": "en",
        "branchofficedetails_branch_office_id": "1",
        "domain_netbios_name_transform": "WORKGROUP",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "pmreshealthstatus_resource_id": null,
        "location_transform": "--",
        "scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
        "branch_office_name_transform": "Local Office",
        "i18n_transform": "French",
        "agent_last_contact_time_transform": "May 18, 2026 05:48 AM",
        "os_platform": "1",
        "agent_last_ds_contact_time": "0",
        "agent_logged_on_users": "pmp-test10",
        "osflavor_id": "0",
        "i18n": "dc.patch.patchinfo.English",
        "search_tag": "--",
        "status_label": "dc.db.som.status.installed_successfully",
        "error_kb_url": null,
        "owner_email_id": "--",
        "agent_installed_dir_transform": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\",
        "installation_status": "22",
        "last_scan_time_transform": "May 17, 2026 08:56 PM",
        "friendly_name_transform": "DESKTOP-3MGS2V0",
        "scan_remarks_transform": "Scanning completed successfully",
        "last_successful_scan": "1779269204807",
        "branchmemberresourcerel_resource_id": "11",
        "computer_status_update_time": "1779101421159",
        "branch_office_name": "Local Office",
        "processor_architecture": "2",
        "agent_last_contact_time": "1779268735000",
        "description": null,
        "owner_email_id_transform": "--",
        "domain_netbios_name": "VMDRQA",
        "status_label_transform": "Installed Successfully",
        "patch_status_label": "dc.common.SCANNING_COMPLETED",
        "ip_address_transform": "192.0.2.13",
        "search_tag_transform": "--",
        "agent_installed_on_transform": "May 15, 2026 02:59 PM",
        "agent_last_bootup_time_transform": "May 16, 2026 01:04 AM",
        "agent_installed_dir": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\",
        "mac_address": "0c:37:96:3c:69:48,00:15:5d:ae:26:77",
        "agent_last_ds_contact_time_transform": "--",
        "scan_remarks_args": null,
        "patch_status_label_transform": "Scanning Completed",
        "patchclientscanerror_resource_id": null,
        "owner": "--",
        "patch_scan_error_code": null,
        "friendly_name": "pmp-test10",
        "scan_status": "228",
        "description_transform": "--",
        "last_successful_scan_transform": "May 17, 2026 08:56 PM",
        "patch_status_image": "images/success.png",
        "last_sync_time": "1779273157893",
        "agent_logged_on_users_transform": "Administrateur",
        "ip_address": "192.0.2.14,192.0.2.15",
        "service_pack_transform": "Windows 10 Version 22H2 (x64)",
        "patchmgmtosinfo_resource_id": "11",
        "agent_version": "11.5.2616.01.W",
        "mac_address_transform": "00:0c:29:51:3e:f7",
        "resource_health_status_transform": "--",
        "agent_last_bootup_time": "1779042799000",
        "resource_id": "11",
        "os_name": "Windows 11 Professional Edition (x64)",
        "location": "--",
        "computer_live_status": "1",
        "resource_name": "pmp-test10",
        "last_scan_time": "1779269204807",
        "customer_id": "1"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
                
▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_code": "INTERNAL_ERROR",
    "error_description": "dc.rest.api_internal_error"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 50 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.