Deletes a published SSP group configuration

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

Removes a published group from the self service portal. Both groupResourceId and collectionId are required to identify the configuration to delete.

Request URL

https://{server-hostname}:8383/dcapi/swDeployment/publishGroup/delete

Scope

SWDeployment.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/deletePublishGroup.v1+jsonapplication/deletePublishGroup.v1+jsonCopied!
AcceptstringMandatory
application/deletePublishGroup.v1+jsonapplication/deletePublishGroup.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
groupResourceIdstringOptional

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

collectionIdstringOptional

Collection ID of the SSP configuration to delete. 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 POST \
  --url https://appdomain/dcapi/swDeployment/publishGroup/delete \
  --header 'Accept: application/deletePublishGroup.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deletePublishGroup.v1+json' \
  --data '{"collectionId":"5001","groupResourceId":"301"}'

Sample Request Body

Delete a published SSP group

Copied!
  {
    "collectionId": "5001",
    "groupResourceId": "301"
  }
                
Show full

Response Parameters

- HTTP code 200

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

0 on success

statusMsgstring

Localized message describing the deletion result

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- 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
401HTTP code
500HTTP code

Sample Response: HTTP 200

Deleted successfully

Copied!
  {
    "statusMsg": "Published group (Engineering Workstations) has been deleted successfully",
    "status": 0
  }
                
Show full

Sample Response: HTTP 401

No access to delete

Copied!
  {
    "errorMessage": "The user has no access to delete published group.",
    "errorCode": "ACCESS_DENIED"
  }
                
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.