[Index]
A Bundle is a logical grouping of packages that are installed together.
Model ref.: relation/Bundle
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Name of the bundle.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"release": {
"title": "Release",
"description": "Overall release of HCS.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"version": {
"title": "Version",
"description": "Version of the bundle.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"previousVersion": {
"title": "Previous Version",
"description": "Previous Version of the bundle.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"build": {
"title": "Solution Build Number",
"description": "The build version of the bundle.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"buildTime": {
"title": "Build Time",
"description": "Timestamp when the bundle was generated.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"branch": {
"title": "Branch",
"description": "The source code branch where the bundle was generated.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"view": {
"title": "View",
"description": "The source code view where the build was generated.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"author": {
"title": "Author",
"description": "The field matches the Author field of each package in the bundle.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"deploymentMode": {
"title": "Deployment Mode",
"description": "Type of deployment mode.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"previousDeploymentMode": {
"title": "Previous Deployment Type",
"description": "Previous Deployment Mode of the bundle.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"platformVersion": {
"title": "Platform Version",
"description": "The VOSS Automate platform version.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"core_version": {
"title": "Core Version",
"description": "The VOSS Automate core version.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"compiled_date_simple": {
"title": "Release Date",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"compiled_date_time": {
"title": "Compiled At",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"deployment_date_simple": {
"title": "Installed On",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"deployment_date_time": {
"title": "Installed On (Detail)",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"patch_bundle": {
"title": "Patch Bundle Number",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"patchDat": {
"title": "Patch Dat",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The unique name of the patch.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"bundleName": {
"title": "Bundle",
"description": "The name of the bundle to which this patch applies.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"description": {
"title": "Description",
"description": "Description of the patch.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"releases": {
"title": "Releases",
"description": "The HCS release to which this patch applies.",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"is_password": false,
"pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+( (ES|SU)[0-9]+[A-Za-z]*){0,1}$"
}
},
"version": {
"title": "Version",
"description": "The version of the patch.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"defect_ids": {
"title": "Defect IDs",
"description": "A list defects that are fixed by this patch.",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"is_password": false
}
},
"models": {
"title": "Models",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "object",
"is_password": false,
"properties": {
"model_type": {
"title": "Type",
"description": "The type of model included in the patch.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"model_instances": {
"title": "Instances",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"items": {
"type": "object",
"properties": {
"model_instance": {
"title": "Instance",
"description": "The business key of the model included in the patch.",
"type": "string",
"maxLength": 1024,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
},
"model_version": {
"title": "Version",
"description": "The new version of the patched model.",
"type": "string",
"maxLength": 1024,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
},
"description": {
"title": "Description",
"description": "Description of the changes that were made to the given model instance.",
"type": "string",
"maxLength": 1024,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
}
}
}
}
}
}
},
"source_code_changes": {
"title": "Source Code Changes",
"description": "Detailed information regarding each source code file that is updated by this patch.",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "object",
"is_password": false,
"properties": {
"chroot": {
"title": "Bubble",
"description": "The platform bubble being patched, for example voss-deviceapi, mongo, nginx.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"filepath": {
"title": "File",
"description": "The path of a file that was patched.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"description": {
"title": "Description",
"description": "Description of the changes that were made to the given source code file.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
}
}
}
},
"notes": {
"title": "Notes",
"description": "A description of any side-effects resulting from applying this patch, such as migration of existing data.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
}
}
}
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/Bundle/add/ |
|
The GUI Add form of relation/Bundle as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/Bundle | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/Bundle/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/Bundle/[pkid1]", "/api/relation/Bundle/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/Bundle/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/Bundle; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/Bundle/export/ |
|
{ "hrefs":["/api/relation/Bundle/[pkid1]", "/api/relation/Bundle/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/Bundle and the JSON format can be used to import instances of relation/Bundle.
GET http://[host-proxy]/api/relation/Bundle/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/Bundle | POST | /api/relation/Bundle/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/Bundle/ |
|
The relation/Bundle schema and all instances as JSON. |
(The list will return 0 to 3 relation/Bundle instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/Bundle/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/Bundle",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "release",
"title": "Release"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/Bundle/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "2.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/Bundle/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/Bundle/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/Bundle/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/Bundle/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/Bundle/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/Bundle/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"deployment_date_time": "16 September 2024 at 08:59 Mon",
"name": "HcsBase",
"author": "VOSS Automate",
"compiled_date_simple": "16 September 2024",
"buildTime": "2024-09-16 08:59:08.126942",
"deployment_date_simple": "16 September 2024",
"core_version": "24.1.2+625c0aeffe",
"previousVersion": "24.1.1 (Provider)",
"version": "This 'version' field has been deprecated, please refer to 'release' for the product version.",
"build": "4826",
"compiled_date_time": "16 September 2024 at 07:30 Mon",
"branch": "release_24.1_patch",
"release": "24.1.2.2",
"platformVersion": "24.1.2-1726465668",
"deploymentMode": "Provider",
"view": "sandboxes/schalk.sevenster/MakeTemplateUsingWhiteList",
"previousDeploymentMode": "Provider",
"pkid": "5da4c4abce894e0012224d68",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "relation/Bundle",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "release",
"title": "Release"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/",
"pkid": "5da4c4aace894e0012224d67"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c4aace894e0012224d67"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5da4c4aace894e0012224d67"
}
]
}
(Show the first instance)
{
"data": {
"deployment_date_time": "16 September 2024 at 08:59 Mon",
"name": "HcsBase",
"author": "VOSS Automate",
"compiled_date_simple": "16 September 2024",
"buildTime": "2024-09-16 08:59:08.126942",
"deployment_date_simple": "16 September 2024",
"core_version": "24.1.2+625c0aeffe",
"previousVersion": "24.1.1 (Provider)",
"version": "This 'version' field has been deprecated, please refer to 'release' for the product version.",
"build": "4826",
"compiled_date_time": "16 September 2024 at 07:30 Mon",
"branch": "release_24.1_patch",
"release": "24.1.2.2",
"platformVersion": "24.1.2-1726465668",
"deploymentMode": "Provider",
"view": "sandboxes/schalk.sevenster/MakeTemplateUsingWhiteList",
"previousDeploymentMode": "Provider",
"patchDat": [
{
"name": "24.1 Delta Bundle 2",
"bundleName": "HcsBase",
"description": "This system has been patched with Delta Bundle 24.1PB2 (see release-documentation for details)",
"releases": [
"24.1.2"
]
}
]
},
"meta": {
"model_type": "relation/Bundle",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "release",
"title": "Release"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "HcsBase",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/",
"pkid": "5da4c4aace894e0012224d67"
}
]
},
"schema_version": "2.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/Bundle/5da4c4aace894e0012224d67/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5da4c4aace894e0012224d67"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/Bundle. | GET | /api/relation/Bundle/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/Bundle as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/Bundle/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/Bundle/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/Bundle; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/Bundle/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/Bundle and the JSON format can be used to import instances of relation/Bundle.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/Bundle/[pkid] | hierarchy=[hierarchy] | The relation/Bundle instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/Bundle/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/Bundle. |