[Index]
A Bundle represents a logical grouping of packages that are validated as a unit.
Model ref.: data/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
}
},
"schema_version": "2.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Bundle/add/ |
|
The GUI Add form of data/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/data/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/data/Bundle/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Bundle/[pkid1]", "/api/data/Bundle/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Bundle/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Bundle; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Bundle/export/ |
|
{ "hrefs":["/api/data/Bundle/[pkid1]", "/api/data/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 data/Bundle and the JSON format can be used to import instances of data/Bundle.
GET http://[host-proxy]/api/data/Bundle/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Bundle | POST | /api/data/Bundle/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Bundle/ |
|
The data/Bundle schema and all instances as JSON. |
(The list will return 0 to 3 data/Bundle instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Bundle/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/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": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"schema_version": "2.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/Bundle/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Bundle/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/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/data/Bundle/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/Bundle/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Bundle/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"deployment_date_time": "23 June 2024 at 21:27 Sun",
"name": "HcsBase",
"author": "VOSS Automate",
"compiled_date_simple": "21 June 2024",
"buildTime": "2024-06-23 21:27:58.190836",
"deployment_date_simple": "23 June 2024",
"core_version": "24.1.0+dev.2acd51511e",
"previousVersion": "21.4.5 (Provider Decoupled)",
"version": "This 'version' field has been deprecated, please refer to 'release' for the product version.",
"build": "2096",
"compiled_date_time": "21 June 2024 at 16:07 Fri",
"branch": "b'b2b2f47b5151b0b13c00cc7b061ba18cc9e6b367'",
"release": "pre-release.24.2.build-2096",
"platformVersion": "24.2.0-1719151192",
"deploymentMode": "Provider",
"view": "pipelines/automate-template-artifact_builder",
"previousDeploymentMode": "Provider Decoupled",
"pkid": "5ad5b24faffa9343e4d928e4",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/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/data/Bundle/5ad5b24faffa9343e4d928e3/",
"pkid": "5ad5b24faffa9343e4d928e3"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b24faffa9343e4d928e3"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5b24faffa9343e4d928e3"
}
]
}
(Show the first instance)
{
"data": {
"deployment_date_time": "23 June 2024 at 21:27 Sun",
"name": "HcsBase",
"author": "VOSS Automate",
"compiled_date_simple": "21 June 2024",
"buildTime": "2024-06-23 21:27:58.190836",
"deployment_date_simple": "23 June 2024",
"core_version": "24.1.0+dev.2acd51511e",
"previousVersion": "21.4.5 (Provider Decoupled)",
"version": "This 'version' field has been deprecated, please refer to 'release' for the product version.",
"build": "2096",
"compiled_date_time": "21 June 2024 at 16:07 Fri",
"branch": "b'b2b2f47b5151b0b13c00cc7b061ba18cc9e6b367'",
"release": "pre-release.24.2.build-2096",
"platformVersion": "24.2.0-1719151192",
"deploymentMode": "Provider",
"view": "pipelines/automate-template-artifact_builder",
"previousDeploymentMode": "Provider Decoupled",
"pkid": "5ad5b24faffa9343e4d928e4"
},
"meta": {
"model_type": "data/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": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/",
"pkid": "5ad5b24faffa9343e4d928e3"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b24faffa9343e4d928e3"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Bundle/5ad5b24faffa9343e4d928e3/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ad5b24faffa9343e4d928e3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Bundle. | GET | /api/data/Bundle/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Bundle as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Bundle/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Bundle/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/Bundle/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/Bundle; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/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 data/Bundle and the JSON format can be used to import instances of data/Bundle.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/Bundle/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Bundle/[pkid] | hierarchy=[hierarchy] | The data/Bundle instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Bundle/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Bundle. |