Retrieve the details of a single script

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 stored details of the specified script, including platform, arguments, successful exit codes, and the associated script file.

Request URL

https://{serverurl}/dcapi/configuration/scriptRepository/{scriptId} Copied!

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

scriptIdstringMandatory

Unique identifier of the script to update. Fetch from List Scripts.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/configuration/scriptRepository/{scriptId} \
  --header 'Accept: application/scriptDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Description of the script

exitCodesstring

Comma-separated list of expected exit codes

platformstring

Target platform of the script. Allowed values:
Windows
Mac
Linux

argumentsstring

Script arguments (decrypted for Windows)

scriptFileJSON Object

Script file reference with fileID and fileName

Show Sub-Attributes
fileIDlong

Unique file ID from the DC file management system

fileNamestring

Original filename of the script

isTemplateScriptboolean

true if this script was added from a template

shareScriptboolean

true if the script is shared with other users. Returned only when isTemplateScript is false

- HTTP code 401

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

Product error code for the authorization failure

errorMsgstring

Localised error message for the error code

- HTTP code 500

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

Product error code for the failure

errorMsgstring

Localised error message for the error code

Sample Response: HTTP 200

Script details for a Windows batch script

Copied!
  {
    "description": "Batch Script to change timezone",
    "exitCodes": "0,1",
    "arguments": "--timezone \"IST\"",
    "scriptFile": {
      "fileName": "ChangeTimeZone.bat",
      "fileID": 12345
    },
    "shareScript": true,
    "platform": "windows",
    "isTemplateScript": false
  }
                
▼ Show full

Sample Response: HTTP 401

The API user does not have the role required for this operation

Copied!
  {
    "errorCode": 1001,
    "errorMsg": "Access denied - You are not allowed to access the requested resource."
  }
                
▼ Show full

Sample Response: HTTP 500

Unexpected server error while retrieving script details

Copied!
  {
    "errorCode": 1003,
    "errorMsg": "An Internal Error occurred, try again later."
  }
                
▼ 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.