[Index]
Model ref.: device/spark/Announcements
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": {
"required": true,
"type": "string",
"title": "Name"
},
"level": {
"enum": [
"LOCATION",
"ORGANIZATION"
],
"type": "string",
"decsription": "The level at which this announcement exists",
"title": "Level"
},
"lastUpdated": {
"type": "string",
"description": "LastUpdated timestamp (in UTC format) of the announcement",
"title": "Last Updated"
},
"fileName": {
"type": "string",
"decsription": "File name of the uploaded binary announcement greeting",
"title": "File Name"
},
"fileSize": {
"type": "string",
"decsription": "Size of the file in kilobytes",
"title": "File Size"
},
"mediaFileType": {
"type": "string",
"description": "Media file type of the announcement file",
"title": "File Type"
},
"id": {
"type": "string",
"title": "id"
},
"location": {
"properties": {
"id": {
"type": "string",
"title": "id"
},
"name": {
"type": "string",
"title": "Location Name"
}
},
"type": "object",
"description": "The details of location at which this announcement exists",
"title": "Location"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/spark/Announcements/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/spark/Announcements/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/Announcements/[pkid1]", "/api/v0/device/spark/Announcements/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/spark/Announcements/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/Announcements |
|
{"hrefs": ["/api/device/spark/Announcements/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/Announcements |
|
{"hrefs": ["/api/device/spark/Announcements/[pkid1]", "/api/device/spark/Announcements/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/Announcements; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/Announcements/export/ |
|
{ "hrefs":["/api/device/spark/Announcements/[pkid1]", "/api/device/spark/Announcements/[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 device/spark/Announcements and the JSON format can be used to import instances of device/spark/Announcements.
GET http://[host-proxy]/api/device/spark/Announcements/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/Announcements | POST | /api/device/spark/Announcements/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/spark/Announcements/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/spark/Announcements/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/spark/Announcements/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/Announcements/ |
|
The device/spark/Announcements schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/Announcements instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/Announcements/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/spark/Announcements/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/Announcements",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Announcements/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/spark/Announcements/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/spark/Announcements/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/Announcements/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/spark/Announcements/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/Announcements/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Announcements/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Announcements/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/spark/Announcements/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/spark/Announcements",
"model_specific_actions": [
"list",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "fileName",
"title": "File Name"
},
{
"name": "fileSize",
"title": "File Size"
},
{
"name": "mediaFileType",
"title": "File Type"
},
{
"name": "level",
"title": "Level"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "location.name",
"title": "Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "65e0a1e96fd4534903e4fe95",
"meta": {
"tags": [],
"cached": true,
"title": "EnterpriseTest",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e0a1e96fd4534903e4fe95",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1e96fd4534903e4fe95/?model_type=device/spark/Announcements",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Announcements",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1e96fd4534903e4fe95"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "fileName",
"title": "File Name"
},
{
"name": "fileSize",
"title": "File Size"
},
{
"name": "mediaFileType",
"title": "File Type"
},
{
"name": "level",
"title": "Level"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "location.name",
"title": "Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "EnterpriseTest",
"level": "ORGANIZATION",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"lastUpdated": "2023-09-06 08:50:05",
"fileName": "1693990203248.wav",
"fileSize": "264",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"mediaFileType": "WAV",
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9lMzhiNTBiMC1hY2YxLTQ0MWEtOTU3My1lZDBjYTYzOTllOGE",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0a1ea6fd4534903e4fead",
"meta": {
"tags": [],
"cached": true,
"title": "on-hold",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1ea6fd4534903e4fead",
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1ea6fd4534903e4fead/?model_type=device/spark/Announcements",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/Announcements/65e0a1ea6fd4534903e4fead/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/Announcements",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1ea6fd4534903e4fead"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "fileName",
"title": "File Name"
},
{
"name": "fileSize",
"title": "File Size"
},
{
"name": "mediaFileType",
"title": "File Type"
},
{
"name": "level",
"title": "Level"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "location.name",
"title": "Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "on-hold",
"level": "ORGANIZATION",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"lastUpdated": "2023-09-08 10:30:09",
"fileName": "humming.wav",
"fileSize": "429",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"mediaFileType": "WAV",
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zYjZmZGU4My0yYzNkLTRlODQtODQ0MC05NGMwYjMwOGUwMmQ",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0a1e96fd4534903e4fe9d",
"meta": {
"tags": [],
"cached": true,
"title": "Test",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1e96fd4534903e4fe9d",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e0a1e96fd4534903e4fe9d/?model_type=device/spark/Announcements",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe9d/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/Announcements",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1e96fd4534903e4fe9d"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "fileName",
"title": "File Name"
},
{
"name": "fileSize",
"title": "File Size"
},
{
"name": "mediaFileType",
"title": "File Type"
},
{
"name": "level",
"title": "Level"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "location.name",
"title": "Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"mediaFileType": "WAV",
"name": "Test",
"level": "LOCATION",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYTc3MGIyLTU3OGMtNGI5Zi04N2RjLTJkMzkyZGEyZGVjZQ",
"name": "VOSS-GBR-Reading"
},
"lastUpdated": "2023-09-01 13:50:39",
"fileName": "1693576231884.wav",
"fileSize": "213",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8yZDRhMzU5Yi04ZTU0LTQxODktYWM3YS0zY2JiMWFmMjc2NTE",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e0a1e96fd4534903e4fe95",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "EnterpriseTest",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "65e0a1e96fd4534903e4fe95",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1e96fd4534903e4fe95/?hierarchy=[hierarchy]&model_type=device/spark/Announcements",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Announcements/65e0a1e96fd4534903e4fe95/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Announcements",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1e96fd4534903e4fe95"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "fileName",
"title": "File Name"
},
{
"name": "fileSize",
"title": "File Size"
},
{
"name": "mediaFileType",
"title": "File Type"
},
{
"name": "level",
"title": "Level"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "location.name",
"title": "Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "EnterpriseTest",
"level": "ORGANIZATION",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"lastUpdated": "2023-09-06 08:50:05",
"fileName": "1693990203248.wav",
"fileSize": "264",
"mediaFileType": "WAV",
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9lMzhiNTBiMC1hY2YxLTQ0MWEtOTU3My1lZDBjYTYzOTllOGE"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/Announcements. | GET | /api/device/spark/Announcements/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/Announcements as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/spark/Announcements/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/spark/Announcements/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/Announcements | 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 device/spark/Announcements; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/Announcements/[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 device/spark/Announcements and the JSON format can be used to import instances of device/spark/Announcements.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/Announcements/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/Announcements/[pkid] | hierarchy=[hierarchy] | The device/spark/Announcements instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/Announcements/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/Announcements. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/Announcements/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |