Fetches group details and published packages for modification

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

Retrieves the group name, collection ID, and list of currently published packages for an SSP group, used to pre-populate the modify form.

Request URL

https://{serverurl}/dcapi/swDeployment/ssp/modifyGroupDetails

Scope

DesktopCentralCloud.SWDeployment.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

groupResourceIdlongMandatory

Custom group resource ID. Obtain from the groupResourceId field in the response of the List SSP Publish Groups API.

collectionIdlongMandatory

SSP collection ID. Obtain from the collectionId field in the response of the Check Custom Group Published API.

Sample Request

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

Response Parameters

- HTTP code 200

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

Display name of the custom group

collectionIdlong

Collection ID of the published configuration

addedPackagesJSON Array

Array of published packages

Show Sub-Attributes
JSON Object
Show Sub-Attributes
packageIdlong

Package ID

packageNamestring

Display name of the package

packageApprovalinteger

0 - published package without approval, 1 - published package with approval (applicable only when integrated with Service Desk Plus)

- HTTP code 500

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

INTERNAL_ERROR for publish/modify failures, SW_INTERNAL_ERROR for SSP configuration errors

errorMessagestring

Internal server error with details about the SSP publish or group operation failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Group with published packages

Copied!
  {
    "groupName": "Engineering Workstations",
    "collectionId": 5001,
    "addedPackages": [
      {
        "packageId": 10001,
        "packageName": "7-Zip 23.01 x64",
        "packageApproval": 0
      }
    ]
  }
                
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.