Retrieve Detailed System-Level Patch 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 a detailed system-level patch report for a specific managed system.

Request URL

https://{serverurl}/dcapi/patch/reports/systemReport 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.

patchStatusstringOptional

Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing. Multiple values can be given as a comma-separated list.

approveStatuslongOptional

Returns only the patches with the given approval status. Accepted values: 211 - Approved, 0 - Not Approved, 212 - Declined.

platFormIdlongOptional

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

severitylongOptional

Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Provide a single numeric value.

resourceIdlongOptional

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

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/systemReport \
  --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
messageResponseJSON Array

Array of system report entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
affected_patch_statusstring

Affected patch status code

affectedpatchstatus_resource_idstring

Resource ID for affected patch status

approveduser_first_namestring

First name of the user who approved the patch

approveduser_first_name_transformstring

Transformed display value of approving user name

bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID display value

collection_namestring

Collection name, or null if not assigned

collection_name_transformstring

Transformed collection name display, -- if null

config_idstring

Configuration ID, or null if not configured

customer_idstring

Customer identifier

customerpatchstatus_patch_idstring

Patch ID from customer patch status

deploy_remarksstring

Deployment remarks, or null

deploy_remarks_argsstring

Deployment remarks arguments, or null

deploy_remarks_transformstring

Transformed deployment remarks, -- if null

deployment_statusstring

Deployment status, or null

download_statusstring

Download status, or null

first_namestring

First name of the deploying user, or null

first_name_transformstring

Transformed deploying user name, -- if null

install_error_codestring

Install error code, or null

installed_timestring

Installed time in epoch, or null

installed_time_transformstring

Transformed installed time display, -- if null

installpatchstatus_patch_idstring

Patch ID from install status, or null

installpatchstatus_resource_idstring

Resource ID from install status, or null

patch_affected_status_imagestring

Image path for affected patch status

patch_affected_status_labelstring

Label key for affected patch status

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_download_status_imagestring

Image path for download status, or null

patch_download_status_labelstring

Label for download status, or null

patch_idstring

Unique patch identifier

patch_id_transformstring

Transformed patch ID

patch_install_status_imagestring

Image path for install status, or null

patch_install_status_labelstring

Label for install status, or null

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch name

patch_norebootstring

Reboot requirement code: 0=May Require, 1=Not Required

patch_noreboot_transformstring

Transformed reboot requirement display

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_statusstring

Patch status code

patch_supported_timestring

Patch supported time in epoch milliseconds

patch_supported_time_transformstring

Formatted patch supported date

patch_typestring

Patch type code

patch_uninstall_statusstring

Uninstall support status code

patch_uninstall_status_transformstring

Transformed uninstall status: Supported, Not Supported

patch_updated_timestring

Last updated time in epoch milliseconds

patch_updated_time_transformstring

Formatted last updated date and time

platformstring

Platform code: 1=Windows, 2=Mac, 3=Linux

platform_namestring

Platform display name

pmseverity_namestring

Severity display name

resource_idstring

Resource identifier

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

status_imagestring

Image path for approval status

status_labelstring

Label key for approval status

status_label_transformstring

Transformed approval status display

superceded_bystring

Superceded by patch ID, or NA

update_idstring

Update type ID

update_namestring

Update type name

update_name_transformstring

Transformed update type name

vendor_namestring

Vendor name

vendor_name_transformstring

Transformed vendor name

metadataJSON Object

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

- 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

System-level patch report

Copied!
  {
    "Links": {
      "next": null,
      "prev": null
    },
    "messageResponse": [
      {
        "affected_patch_status": "201",
        "affectedpatchstatus_resource_id": "16222000000271157",
        "approveduser_first_name": "DC-SYSTEM-USER",
        "approveduser_first_name_transform": "DC-SYSTEM-USER",
        "bulletin_id": "MS22-JAN14",
        "bulletin_id_transform": "BI-001",
        "collection_name": null,
        "collection_name_transform": "--",
        "config_id": null,
        "customer_id": "16222000000226138",
        "customerpatchstatus_patch_id": "32830",
        "deploy_remarks": null,
        "deploy_remarks_args": null,
        "deploy_remarks_transform": "--",
        "deployment_status": null,
        "download_status": null,
        "first_name": null,
        "first_name_transform": "--",
        "install_error_code": null,
        "installed_time": null,
        "installed_time_transform": "--",
        "installpatchstatus_patch_id": null,
        "installpatchstatus_resource_id": null,
        "patch_affected_status_image": "images/success.gif",
        "patch_affected_status_label": "dc.common.INSTALLED",
        "patch_description": "KB5009719, 2022-01 Security and Quality Rollup for .NET Framework 4.5.2 for Windows 7 for x64 (KB5008860) (ESU)",
        "patch_description_transform": "ChengMing 3900 (1.26.0)",
        "patch_download_status_image": null,
        "patch_download_status_label": null,
        "patch_id": "32830",
        "patch_id_transform": "1414963",
        "patch_install_status_image": null,
        "patch_install_status_label": null,
        "patch_name": "Ndp45-kb5008860-x64.exe",
        "patch_name_transform": "ChengMing_3900_3901_01.26.00.exe",
        "patch_noreboot": "0",
        "patch_noreboot_transform": "May Require",
        "patch_released_time": "1641924028000",
        "patch_released_time_transform": "Nov 6, 2024",
        "patch_status": "211",
        "patch_supported_time": "1641934828000",
        "patch_supported_time_transform": "Nov 7, 2024",
        "patch_type": "7",
        "patch_uninstall_status": "0",
        "patch_uninstall_status_transform": "Not Supported",
        "patch_updated_time": "1770718649504",
        "patch_updated_time_transform": "Feb 10, 2026 03:47 PM",
        "platform": "1",
        "platform_name": "Windows",
        "pmseverity_name": "Important",
        "resource_id": "16222000000271157",
        "severity": "3",
        "severity_name": "dc.common.IMPORTANT",
        "severity_transform": "Critical",
        "status_image": "images/approved_icon.gif",
        "status_label": "dc.common.APPROVED",
        "status_label_transform": "Approved",
        "superceded_by": "NA",
        "update_id": "7",
        "update_name": "Rollups",
        "update_name_transform": "BIOS",
        "vendor_name": "Microsoft",
        "vendor_name_transform": "Dell"
      }
    ],
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "status": "success",
    "totalPages": 1,
    "totalRecords": "1"
  }
                
▼ 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.