Modifies the packages published in an existing SSP group

Updates the list of packages published in a self service portal group. Requires the collection ID from the existing published configuration.

Endpoints

post /dcapi/swDeployment/publishGroup/modify

Copy full URL

Request URL

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

Scope

SWDeployment.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/modifyPackageGroup.v1+jsonCopied!

AcceptstringMandatory

application/modifyPackageGroup.v1+jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

groupResourceIdstringOptional

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

configTypeintegerOptional

Configuration type: 1=Computer, 2=User

collectionIdstringOptional

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

packageDetailsJSON ArrayOptional

Array of package publish detail objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

packageIdlongOptional

Package ID to publish. Obtain from the packageId field in the response of the List Packages API.

packageApprovalintegerOptional

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

credentialDetailsJSON ObjectOptional

Optional credential details for run-as-user installs. Get available credentials from the List Credentials API.

Show Sub-Attributes

credentialIDlongOptional

Credential identifier

credentialUUIDstringOptional

Credential UUID string

credentialNamestringOptional

Display name of the credential

installUsingstringOptional

Optional install context: systemUser, targetUser, or runAsUser

allowUserToInteractbooleanOptional

Optional flag to allow user interaction during installation

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/dcapi/swDeployment/publishGroup/modify \
  --header 'Accept: application/modifyPackageGroup.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/modifyPackageGroup.v1+json' \
  --data '{"packageDetails":[{"packageId":10001,"packageApproval":0},{"packageId":10004,"packageApproval":1}],"configType":1,"collectionId":"5001","groupResourceId":"301"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/swDeployment/publishGroup/modify"))
        .header("Content-Type", "application/modifyPackageGroup.v1+json")
        .header("Accept", "application/modifyPackageGroup.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"packageDetails\":[{\"packageId\":10001,\"packageApproval\":0},{\"packageId\":10004,\"packageApproval\":1}],\"configType\":1,\"collectionId\":\"5001\",\"groupResourceId\":\"301\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"packageDetails\":[{\"packageId\":10001,\"packageApproval\":0},{\"packageId\":10004,\"packageApproval\":1}],\"configType\":1,\"collectionId\":\"5001\",\"groupResourceId\":\"301\"}"

headers = {
    'Content-Type': "application/modifyPackageGroup.v1+json",
    'Accept': "application/modifyPackageGroup.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/swDeployment/publishGroup/modify", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/modifyPackageGroup.v1+json");
    headersMap.put("Accept", "application/modifyPackageGroup.v1+json");

    data=Map();
    data.put("groupResourceId","value");
    data.put("configType","1");
    data.put("collectionId","value");
    data_packageDetails=List();
    data_packageDetails_item1=Map();
    data_packageDetails_item1.put("packageId","1");
    data_packageDetails_item1.put("packageApproval","1");
    data_packageDetails_item1_credentialDetails=Map();
    data_packageDetails_item1_credentialDetails.put("credentialID","1");
    data_packageDetails_item1_credentialDetails.put("credentialUUID","value");
    data_packageDetails_item1_credentialDetails.put("credentialName","value");
    data_packageDetails_item1.put("credentialDetails",data_packageDetails_item1_credentialDetails);
    data_packageDetails_item1.put("installUsing","value");
    data_packageDetails_item1.put("allowUserToInteract",true);
    data_packageDetails.add(data_packageDetails_item1);
    data.put("packageDetails",data_packageDetails);

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/swDeployment/publishGroup/modify"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/modifyPackageGroup.v1+json")
$headers.Add("Accept", "application/modifyPackageGroup.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/swDeployment/publishGroup/modify' -Method POST -Headers $headers -ContentType 'application/modifyPackageGroup.v1+json' -Body '{"packageDetails":[{"packageId":10001,"packageApproval":0},{"packageId":10004,"packageApproval":1}],"configType":1,"collectionId":"5001","groupResourceId":"301"}'

Sample Request Body

Replace packages in SSP group

Copied!

  {
    "packageDetails": [
      {
        "packageId": 10001,
        "packageApproval": 0
      },
      {
        "packageId": 10004,
        "packageApproval": 1
      }
    ],
    "configType": 1,
    "collectionId": "5001",
    "groupResourceId": "301"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusMsgstring

Localized message describing the publish result. Contains success confirmation, archived package warning, or invalid package error.

- 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

Modified successfully

Copied!

  {
    "statusMsg": "Packages published for the Group (Engineering Workstations)"
  }

▼ Show full

Sample Response: HTTP 401

No access to modify

Copied!

  {
    "errorMessage": "The user has no access to modify 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.