Checks whether a custom group is already published in SSP

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

Determines if a custom group has packages published in the self service portal. Returns the collection ID and group details when published, which are needed for modify and delete operations.

Request URL

https://{server-hostname}:8383/dcapi/swDeployment/ssp/customGroupPublished

Scope

SWDeployment.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

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

0 indicates NOT published, 1 indicates IS published in SSP

groupTypeinteger

Group type: 1=Computer, 2=User. Present only when cgSelected=1.

resourceIdlong

Resource ID of the custom group. Present only when cgSelected=1.

groupNamestring

Display name of the custom group. Present only when cgSelected=1.

collectionIdlong

Collection ID of the published SSP configuration. Present only when cgSelected=1.

groupCategoryinteger

Group category: 1=Static, 2=Dynamic. Present only when cgSelected=1.

- 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 not published — only cgSelected is returned, other fields are absent

Copied!
  {
    "cgSelected": 0
  }
                
Show full

Group is published with full details

Copied!
  {
    "cgSelected": 1,
    "groupType": 1,
    "resourceId": 301,
    "groupName": "Engineering Workstations",
    "groupCategory": 1,
    "collectionId": 5001
  }
                
Show full

Sample Response: HTTP 500

Server error

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