This web service lets users delete a content package.
| Method |
Endpoint |
DELETE |
/api/khub/packages/{packageId} |
| Path parameter |
Type |
Description |
{packageId} |
String |
The identifier of the package. |
Response body
{
"id": "GpHewDLJ-r3HPaFi2D83l",
"collectionId": "f6cf52b7-722d-419e-8817-33a127215ec8",
"collectionOwner": {
"id": "9aab1622-6b63-47af-a90a-68bb7939c214",
"displayName": "John",
"emailAddress": "john.doe@example.com"
},
"collectionTitle": "Collection number one",
"uiLocale": "en-US",
"startDate": "2023-08-10T07:38:14.849+00:00",
"endDate": "2023-08-10T07:38:18.452+00:00",
"status": "SUCCESS",
"zipExists": false
}
| Field |
Type |
Description |
id |
String |
The identifier of the package. |
collectionId |
String |
The identifier of the packaged collection. |
collectionOwner |
Object |
Information about the user who created the packaged collection. |
id |
String |
The identifier of the user. |
displayName |
String |
The display name of the user. |
emailAddress |
String |
The email address of the user. |
collectionTitle |
String |
The title of the packaged collection. |
uiLocale |
String |
The UI locale of the package. |
startDate |
String |
The start date and time of the package creation. Date is in YYYY-MM-DD format, and time is in 24-hour format, GMT. |
endDate |
String |
The end date and time of the package creation. Date is in YYYY-MM-DD format, and time is in 24-hour format, GMT. |
status |
String |
Indicates whether the creation of the package succeeded (can be WORKING, SUCCESS, or ERROR). |
zipExists |
Boolean |
Indicates whether users can download the package. |