Use this resource to request license information about bundles installed on or available to the organization. You can also install a bundle and uninstall a bundle.
GET Request
To request license information for a bundle associated with to the organization, use the bundle ID in the following URI:
/api/v2/bundleObjectLicense/<bundleObjectId>
To request license information for all bundles associated with the organization, omit the optional bundle ID.
GET Response
If successful, returns the BundleObjectLicenseType for the requested bundle.
If you request license information for all bundles, returns the bundleObjectLicense object for all bundles associated with the organization.
Returns the error object if errors occur.
The bundleObjectLicense object includes the following attributes:
| Field | Type | Description |
|---|---|---|
| bundleObjectId | String | Bundle ID. |
| orgId | String | Organization ID. |
| updateOption | String | This attribute is not used at this time. |
| licenseType | String | Bundle type. Returns one of the following values: Free Trial Subscription |
| endDate | Date/time | Date the license expires. Returns NULL for free public bundles. |
| numberOfDaysToApply | Int | Not used at this time. |
| numberOfMonthsToApply | Int | Not used at this time. |
| beginDate | Date/time | Publish date for the bundle. |
| bundleVersion | String | Version number for the bundle. |
| createTime | Date/time | Creation date for the bundle. |
| installed | Boolean | Indicates if the organization installed the bundle. Returns TRUE for installed bundles and FALSE for available bundles. |
| active | Boolean | Indicates that the bundle is available and active. Returns TRUE. |
| accessCode | String | Required to install a licensed bundle. Used for sharing private bundles. Read only. |
POST Request
To install a bundle on the organization, use the following URI:
/api/v2/bundleObjectLicense
With this URI, use the following attribute in a bundleObjectLicense object:
| Field | Type | Required | Description |
|---|---|---|---|
| bundleObjectId | String | Yes | The ID of the bundle. |
POST Response
Returns the success response if the request is successful. Returns the error object if errors occur
DELETE Request
To uninstall a bundle from the organization, use the following URI
/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>
Use the following bundleObjectLicense Delete URI attributes:
| Field | Type | required | Description |
|---|---|---|---|
| bundleObjectId | String | Yes | The ID of the bundle. |
| updateOption | String | Defines what happens if objects in the bundle are used. Use one of the following options: DELETE_EXISTING_OBJECTS. Deletes the objects that use the bundle object. UPDATE_EXISTING_OBJECTS. Updates the object that uses the bundle object. EXCEPTION_IF_IS_USED. Returns a message when a bundle object is used and cancels the uninstallation. |
DELETE Response
Returns the success response if the request is successful. Returns the error object if errors occur.