Skip to main content

Bundles Model

Overview​

The bundles table is used to store metadata and configurations related to software bundles. These bundles represent packaged applications, components, or modules that can be deployed within an organization.

Fields​

FieldTypeDescriptionRequired
idstringPrimary Key – Unique identifier for the bundle (UUID).❌
storagePathanyPath where the bundle is stored.❌
orgIdanyOrganization associated with this bundle.❌
buildTypeanyType of build❌
created_atdateTimestamp when the build was created.❌
modified_atdateTimestamp when the build was last update.❌
logStoragePathanyPath where logs related to the bundle are stored.❌
bundle_idstringUnique identifier for the bundle version.✅
iconanyicon field❌
namestringName of the bundle✅
versionstringVersion number of the bundle.✅
descriptionstringBrief description of the bundle.❌
pack_dataanyEncapsulated data related to the bundle (e.g., configurations, metadata).✅
devicesanyList of devices compatible with the bundle.❌
featuresstringFeatures included in the bundle.❌
release_notesstringRelease notes for this bundle (optional).❌
isDefaultStoragebooleanIndicates whether this bundle is stored in the default storage (1 = true, 0 = false).❌
storagePropertiesanyAdditional properties related to storage configuration.❌
archiveStoragePathanyPath where archived versions of the bundle are stored.❌
license_keyanyLicense key associated with the bundle.❌
orgGroup_idstringIdentifier for the organization group associated with this bundle.❌
bundleRecordIdanyReference to a record associated with the bundle.❌
user_idanyThe user who created or manages the bundle.❌
statusanyCurrent status of the bundle (e.g., active, inactive).✅
bundle_typestringDefines the type of the bundle (e.g., "software", "plugin").✅
bundleTypestringAlternative representation of bundle_type (possible redundancy).❌
siteIdanyIdentifier of the site where the bundle is deployed.❌
application_item_idanyReference to the associated application item.❌
siteMapIdstringIdentifier linking the bundle to a site map.✅

Sample JSON​

{
"id": "example_value",
"storagePath": "example_value",
"orgId": "example_value",
"buildType": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"logStoragePath": "example_value",
"bundle_id": "example_value",
"icon": "example_value",
"name": "example_value",
"version": "example_value",
"description": "example_value",
"pack_data": "example_value",
"devices": "example_value",
"features": "example_value",
"release_notes": "example_value",
"isDefaultStorage": "example_value",
"storageProperties": "example_value",
"archiveStoragePath": "example_value",
"license_key": "example_value",
"orgGroup_id": "example_value",
"bundleRecordId": "example_value",
"user_id": "example_value",
"status": "example_value",
"bundle_type": "example_value",
"bundleType": "example_value",
"siteId": "example_value",
"application_item_id": "example_value",
"siteMapId": "example_value"
}