Create a content package - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service lets users create a content package.

Method Endpoint
POST /api/khub/packages

Request example

The following lines show an example of a JSON request body:

{
  "userId": "9aab1622-6b63-47af-a90a-68bb7939c214",
  "collectionId": "12c11129-ae99-4aef-88c5-d10f6e8ecac8",
  "uiLocale": "es-ES"
}
Field Type Required? Description
userId String Yes The identifier of the user who created the packaged collection.
collectionId String Yes The identifier of the packaged collection.
uiLocale String Yes The UI locale of the package.

Response body

{
    "id": "LqQ2LaHK2zvEBK7T3quVS",
    "collectionId": "12c11129-ae99-4aef-88c5-d10f6e8ecac8",
    "collectionOwner": {
        "id": "9aab1622-6b63-47af-a90a-68bb7939c214",
        "displayName": "John",
        "emailAddress": "john.doe@example.com"
    },
    "collectionTitle": "Collection number three",
    "uiLocale": "es-ES",
    "startDate": "2023-08-11T08:16:40.442+00:00",
    "status": "WORKING",
    "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 end 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.