Retrieves the current state of the template subsystem

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

Fetches template package creation status, proxy configuration, latest template count, upgrade-available template count, and Patch DB sync status.

Request URL

https://{serverurl}/dcapi/swDeployment/sofwareTemplateParams

Scope

DesktopCentralCloud.SWDeployment.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/sofwareTemplateParams.v1+jsonapplication/sofwareTemplateParams.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/swDeployment/sofwareTemplateParams \
  --header 'Accept: application/sofwareTemplateParams.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

true if a template package creation task is in progress

isCreatedPackageboolean

true if any template packages have been created

isProxyDefinedboolean

true if a proxy server is configured

latestTemplateCountinteger

Number of latest-version templates available

upgradeTemplateCountinteger

Number of templates with newer versions available

patchDBInprogressboolean

true if Patch DB sync is in progress

- HTTP code 500

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

INTERNAL_ERROR for general failures, SW_INTERNAL_ERROR for software deployment internal errors

errorMessagestring

Internal server error with details about the template/auto-update operation failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Normal operational state

Copied!
  {
    "upgradeTemplateCount": 12,
    "pkgCreationStatus": false,
    "isCreatedPackage": true,
    "latestTemplateCount": 145,
    "isProxyDefined": true,
    "patchDBInprogress": false
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errorMessage": "Internal Server Error",
    "errorCode": "INTERNAL_ERROR"
  }
                
Show full

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