Retrieves a pre-configured template for creating a new 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 template details for a specific system tools task template, including the pre-configured tool selection and parameters. Used to populate the task creation form with predefined template defaults.

Request URL

https://{server-hostname}:8383/dcapi/tools/systemTools/template/{templateId}

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

templateIdstringMandatory

The unique identifier of the template

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/systemTools/template/{templateId} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the system tools template

templateNamestring

User-defined name of the system tools template

toolSelectionarray

Array of selected tool identifiers included in this template

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "toolSelection": [
      "CHECK_DISK",
      "DISK_DEFRAGMENTER",
      "CLEAN_UP_DISK"
    ],
    "templateName": "Full Disk Maintenance",
    "templateId": 3
  }
                
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.