Retrieves the full details of a software package

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 complete package information including metadata, install/uninstall commands, uploaded files, and pre/post install scripts.

Request URL

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

Scope

DesktopCentralCloud.SWDeployment.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

packageIDlongMandatory

Unique package identifier. Obtain from the packageId field in the response of the List Packages API.

Sample Request

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

Response Parameters

- HTTP code 200

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

Unique package identifier

packageNamestring

Display name of the package

platforminteger

Platform ID: 1=Windows, 2=Mac, 3=Linux

licenseTypeinteger

License type: 1=Commercial, 2=Non-Commercial

descriptionstring

User-provided description

installCommandstring

Command used for installation

uninstallCommandstring

Command used for uninstallation

uploadedFileJSON Array

Array of uploaded installer files

Show Sub-Attributes
JSON Object
Show Sub-Attributes
fileNamestring

Name of the uploaded file

fileSizelong

Size of the file in bytes

fileIdlong

DC file system identifier

preInstallCommandstring

Pre-installation script or command

postInstallCommandstring

Post-installation script or command

- HTTP code 500

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

INTERNAL_ERROR for DB query failures, SW_INTERNAL_ERROR for package operation errors

errorMessagestring

Internal server error with details about the package retrieval or execution status failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Windows MSI package

Copied!
  {
    "licenseType": 2,
    "installCommand": "msiexec /i 7z2301-x64.msi /qn",
    "preInstallCommand": "",
    "postInstallCommand": "",
    "packageId": 10001,
    "description": "7-Zip file archiver",
    "packageName": "7-Zip 23.01 x64",
    "uninstallCommand": "msiexec /x {ProductCode} /qn",
    "platform": 1,
    "uploadedFile": [
      {
        "fileName": "7z2301-x64.msi",
        "fileSize": 1884160,
        "fileId": 99001
      }
    ]
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errorMessage": "Internal Server Error",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.