Retrieves a summary overview of the specified system tools 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

Returns the summary overview details of the specified system tools collection task, including label, configuration type, deployment status, tool list, and target summary.

Request URL

https://{serverurl}/dcapi/tools/systemTools/{collectionId}/details

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/systemTools/{collectionId}/details \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

System tools collection task unique identifier

labelstring

User-defined task label

configurationTypestring

Primary tool type: CHECK_DISK, DISK_DEFRAGMENTER, CLEAN_UP_DISK, or ST_SCHEDULER

statusstring

Current task status: Active, Suspended, Draft

targetCountinteger

Number of target computers

lastExecutedTimelong

Epoch timestamp of the last execution

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "lastExecutedTime": 1711180800000,
    "label": "Weekly Disk Cleanup",
    "configurationType": "CLEAN_UP_DISK",
    "collectionId": 12,
    "targetCount": 25,
    "status": "Active"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.