Retrieve Systems View for a Specific APD Task

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 the systems view for a specific Automated Patch Deployment (APD) task.

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/apdSystemsView.v1+jsonapplication/apdSystemsView.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.

taskIdlongMandatory

Unique identifier of the Automated Patch Deployment (APD) task whose mapped systems need to be retrieved. Get the value from Get APD Tasks

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/patch/reports/apdSystemsView?taskId=SOME_INTEGER_VALUE' \
  --header 'Accept: application/apdSystemsView.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
messageResponseJSON Array

Array of APD task systems view entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
AgentInstalledDatestring

Date and time the agent was installed on the system

AgentInstalledDirectorystring

File system path where the agent is installed

AgentVersionstring

Version of the agent installed on the system

ComputerNamestring

Name of the computer

DeploymentStatusstring

Status of the APD task deployment on this system, e.g., Patches Missing

DeviceFriendlyNamestring

Friendly/display name of the device

Domainstring

Domain name of the computer

FailedPatchesstring

Number of patches that failed to install, or --

InstalledPatchesstring

Number of installed patches, or --

Languagestring

Operating system language

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last contacted time with distribution server, or --

LastDeploymentTimestring

Last time a deployment was executed on this system, or --

LastSuccessfulScanstring

Last successful scan time

LoggedOnUsersstring

Currently logged on users

MissingPatchesstring

Number of missing patches, or --

OperatingSystemstring

Full operating system name and architecture

Remarksstring

Additional remarks, or --

RemoteOfficestring

Remote office name

ServicePackstring

Service pack or OS version

UpdatedAtstring

Last updated timestamp, or --

WolRemarksstring

Wake-on-LAN remarks, or --

WolStatusstring

Wake-on-LAN status, or --

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

APD task systems view

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "OperatingSystem": "Windows 11 Professional Edition (x64)",
        "AgentVersion": "11.5.2627.37.W",
        "DeviceFriendlyName": "WIN-SYSTEM-01",
        "LastSuccessfulScan": "Sep 7, 2026 11:02 PM",
        "UpdatedAt": "--",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "Default Remote Office",
        "LoggedOnUsers": "user01",
        "WolStatus": "--",
        "FailedPatches": "0",
        "Language": "English",
        "Remarks": "--",
        "LastContactTime": "Aug 27, 2026 07:07 PM",
        "MissingPatches": "0",
        "AgentInstalledDate": "Aug 27, 2026 07:07 PM",
        "ServicePack": "Windows 11 Version 23H2 (x64)",
        "ComputerName": "WIN-SYSTEM-01",
        "WolRemarks": "--",
        "InstalledPatches": "0",
        "LastDeploymentTime": "--",
        "Domain": "WORKGROUP",
        "AgentInstalledDirectory": "C:\\Program Files (x86)\\DesktopCentral_Agent\\",
        "DeploymentStatus": "Patches Missing"
      }
    ],
    "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.