Retrieve List of APD Tasks

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 list of all Automated Patch Deployment (APD) tasks.

Request URL

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

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.

SEARCH_COLUMNstringOptional

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

SEARCH_VALUEstringOptional

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

- 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/apdTasks \
  --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 APD task entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
task_namestring

APD task name

total_target_transformstring

Transformed total target systems count

task_idstring

APD task ID

task_name_transformstring

Transformed APD task name

os_platform_namestring

OS platform name (Windows, Mac, Linux)

collection_idstring

Collection ID associated with the task

first_name_transformstring

Transformed name of the task creator

task_id_transformstring

Transformed task ID or authorization status

collection_statusstring

Collection status code

task_modified_timestring

Task last modified time in epoch milliseconds

template_id_transformstring

Transformed deployment policy template ID, or --

scheduler_class_idstring

Scheduler class ID, or null

remarks_transformstring

Transformed remarks

task_creation_timestring

Task creation time in epoch milliseconds

first_namestring

Name of the task creator

os_platform_idstring

OS platform ID

os_platform_name_transformstring

Transformed OS platform name

modifieduser_first_name_transformstring

Transformed name of the user who last modified the task

total_targetstring

Total target systems count

modifieduser_first_namestring

Name of the user who last modified the task

labelstring

Task type label key

label_transformstring

Transformed task type label

user_idstring

User ID of the task creator

task_modified_time_transformstring

Formatted task last modified time

template_idstring

Deployment policy template ID

task_typestring

Task type code

remarksstring

Remarks or collection ID reference

task_creation_time_transformstring

Formatted task creation time

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

APD tasks list

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "2",
    "messageResponse": [
      {
        "task_name": "MyTask3",
        "total_target_transform": "2",
        "task_id": "310",
        "task_name_transform": "MyTask2",
        "os_platform_name": "Windows",
        "collection_id": "302",
        "first_name_transform": "admin",
        "task_id_transform": "Not Authorized",
        "collection_status": "4",
        "task_modified_time": "1778828832922",
        "template_id_transform": "--",
        "scheduler_class_id": null,
        "remarks_transform": "",
        "task_creation_time": "1778828832922",
        "first_name": "admin",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "modifieduser_first_name_transform": "admin",
        "total_target": "2",
        "modifieduser_first_name": "admin",
        "label": "dc.conf.conf_param.Auto_Install_FeaturePack",
        "label_transform": "Auto Install Patch",
        "user_id": "1",
        "task_modified_time_transform": "May 15, 2026 12:36 PM",
        "template_id": "2",
        "task_type": "18",
        "remarks": "302",
        "task_creation_time_transform": "May 15, 2026 12:36 PM"
      },
      {
        "task_name": "MyTask2",
        "total_target_transform": "2",
        "task_id": "309",
        "task_name_transform": "MyTask2",
        "os_platform_name": "Windows",
        "collection_id": "301",
        "first_name_transform": "admin",
        "task_id_transform": "Not Authorized",
        "collection_status": "3",
        "task_modified_time": "1778828792217",
        "template_id_transform": "--",
        "scheduler_class_id": null,
        "remarks_transform": "",
        "task_creation_time": "1778828792217",
        "first_name": "admin",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "modifieduser_first_name_transform": "admin",
        "total_target": "2",
        "modifieduser_first_name": "admin",
        "label": "dc.conf.conf_param.Auto_Install_Patch",
        "label_transform": "Auto Install Patch",
        "user_id": "1",
        "task_modified_time_transform": "May 15, 2026 12:36 PM",
        "template_id": "2",
        "task_type": "18",
        "remarks": "301",
        "task_creation_time_transform": "May 15, 2026 12:36 PM"
      }
    ],
    "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.