[Index]
Model ref.: device/spark/Location
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": {
"type": "string",
"description": "The name of the location.",
"title": "Name"
},
"preferredLanguage": {
"type": "string",
"description": "The preferred language of the location.",
"title": "Preferred Language"
},
"notes": {
"type": "string",
"title": "Notes"
},
"longitude": {
"type": "number",
"title": "Longitude"
},
"orgId": {
"type": "string",
"description": "The ID of the organization to which this location belongs.",
"title": "Organization ID"
},
"address": {
"properties": {
"city": {
"type": "string",
"description": "The city where the location is located.",
"title": "City"
},
"address1": {
"type": "string",
"description": "The first line of the location's street address.",
"title": "Address Line 1"
},
"address2": {
"type": "string",
"description": "The second line of the location's street address.",
"title": "Address Line 2"
},
"state": {
"type": "string",
"description": "The state where the location is located.",
"title": "State"
},
"country": {
"type": "string",
"description": "The two-letter country code of the location.",
"title": "Country"
},
"postalCode": {
"type": "string",
"description": "The postal code or zip code of the location.",
"title": "Postal Code"
}
},
"type": "object",
"description": "The address of the location.",
"title": "Address"
},
"latitude": {
"type": "number",
"title": "Latitude"
},
"timeZone": {
"type": "string",
"description": "The time zone associated with this location.",
"title": "Time Zone"
},
"id": {
"type": "string",
"description": "A unique identifier for the location.",
"title": "ID"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/spark/Location/add/ |
|
The GUI Add form of device/spark/Location 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/device/spark/Location | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/Location |
|
{"hrefs": ["/api/device/spark/Location/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/Location |
|
{"hrefs": ["/api/device/spark/Location/[pkid1]", "/api/device/spark/Location/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/Location; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/Location/export/ |
|
{ "hrefs":["/api/device/spark/Location/[pkid1]", "/api/device/spark/Location/[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/Location and the JSON format can be used to import instances of device/spark/Location.
GET http://[host-proxy]/api/device/spark/Location/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/Location | POST | /api/device/spark/Location/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/Location/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/Location/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/Location/ |
|
The device/spark/Location schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/Location instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/Location/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 21
},
"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": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/spark/Location/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/Location",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Location/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/Location/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Location/+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/Location/+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/Location/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/Location/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/Location/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Location/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Location/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Location",
"model_specific_actions": [
"fetch_floors",
"list",
"get",
"add",
"update",
"move",
"clone",
"export",
"export_bulkload_template",
"configuration_template",
"field_display_policy",
"help",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "preferredLanguage",
"title": "Preferred Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.city",
"title": "City"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address1",
"title": "Address Line 1"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address2",
"title": "Address Line 2"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.state",
"title": "State"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.postalCode",
"title": "Postal Code"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.country",
"title": "Country"
},
{
"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": "65e040dd6fd4534903e05b45",
"meta": {
"tags": [],
"cached": true,
"title": "MW-Lilongwe",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e032dd6fd4534903dff71c",
"href": "/api/v0/data/Spark/65e032dd6fd4534903dff71c"
}
],
"self": [
{
"pkid": "65e040dd6fd4534903e05b45",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/"
}
],
"parent": [
{
"pkid": "65e040e06fd4534903e05b98",
"href": "/api/data/HierarchyNode/65e040e06fd4534903e05b98"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e040dd6fd4534903e05b45/?model_type=device/spark/Location",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/help",
"method": "GET",
"title": "Help"
}
},
{
"fetch_floors": {
"support_async": true,
"class": "custom",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/+fetch_floors/",
"method": "POST",
"title": "Fetch Floors"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Location",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e040e06fd4534903e05b98",
"65e040dd6fd4534903e05b45"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "preferredLanguage",
"title": "Preferred Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.city",
"title": "City"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address1",
"title": "Address Line 1"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address2",
"title": "Address Line 2"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.state",
"title": "State"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.postalCode",
"title": "Postal Code"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.country",
"title": "Country"
},
{
"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": "MW-Lilongwe",
"preferredLanguage": "en_US",
"longitude": 18.5202187,
"hierarchy": "5f3ae552ce894e00120537fa",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9mOTYwOWM5MS03MDkxLTQyZmYtYmQ2YS04ZWEzOTQxNWExZmE",
"address": {
"city": "Cape Town",
"address1": "3 Waterhouse Pl, Century City, Cape Town, 7441, South Africa",
"address2": "",
"state": "ZA-WC",
"country": "ZA",
"postalCode": "7441"
},
"latitude": -33.8886324,
"timeZone": "Africa/Johannesburg",
"hierarchy_friendly_name": "MW-Lilongwe (Site)",
"summary_device": "Connection parameters for Spark Customer AB_Group, AB_Group, hcs.CS-P.CS-AB.AB_Group",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc1NGQ1NDU1LTBkNzYtNDg3MS1hOTRmLWJhOTFiYjE2ZGNjZQ",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.MW-Lilongwe"
}
},
{
"pkid": "65e040c96fd4534903e05936",
"meta": {
"tags": [],
"cached": true,
"title": "NA-Windhoek",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e032dd6fd4534903dff71c",
"href": "/api/v0/data/Spark/65e032dd6fd4534903dff71c"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e040c96fd4534903e05936",
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/"
}
],
"parent": [
{
"pkid": "65e040cc6fd4534903e05989",
"href": "/api/data/HierarchyNode/65e040cc6fd4534903e05989"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e040c96fd4534903e05936/?model_type=device/spark/Location",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"fetch_floors": {
"support_async": true,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/+fetch_floors/",
"title": "Fetch Floors",
"class": "custom",
"method": "POST"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/Location/65e040c96fd4534903e05936/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/Location",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e040cc6fd4534903e05989",
"65e040c96fd4534903e05936"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "preferredLanguage",
"title": "Preferred Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.city",
"title": "City"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address1",
"title": "Address Line 1"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address2",
"title": "Address Line 2"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.state",
"title": "State"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.postalCode",
"title": "Postal Code"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.country",
"title": "Country"
},
{
"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": "NA-Windhoek",
"preferredLanguage": "en_US",
"longitude": 18.5202187,
"hierarchy": "5f3ae552ce894e00120537fa",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9mOTYwOWM5MS03MDkxLTQyZmYtYmQ2YS04ZWEzOTQxNWExZmE",
"address": {
"city": "Cape Town",
"address1": "2 Waterhouse Pl, Century City, Cape Town, 7441, South Africa",
"address2": "",
"state": "ZA-WC",
"country": "ZA",
"postalCode": "7441"
},
"latitude": -33.8886324,
"timeZone": "Africa/Johannesburg",
"hierarchy_friendly_name": "NA-Windhoek (Site)",
"summary_device": "Connection parameters for Spark Customer AB_Group, AB_Group, hcs.CS-P.CS-AB.AB_Group",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M4MGY3YTk4LTdmOTItNDE1Ni1iNWRjLWYzYjU0ODAyMDBhNg",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.NA-Windhoek"
}
},
{
"pkid": "65e093936fd4534903e270b5",
"meta": {
"tags": [],
"cached": true,
"title": "VOSS-AUS-Sydney",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e093936fd4534903e270b5",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e093936fd4534903e270b5/?model_type=device/spark/Location",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/help",
"class": "help",
"title": "Help"
}
},
{
"fetch_floors": {
"support_async": true,
"method": "POST",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/+fetch_floors/",
"class": "custom",
"title": "Fetch Floors"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/Location/65e093936fd4534903e270b5/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/Location",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e093936fd4534903e270b5"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "preferredLanguage",
"title": "Preferred Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.city",
"title": "City"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address1",
"title": "Address Line 1"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address2",
"title": "Address Line 2"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.state",
"title": "State"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.postalCode",
"title": "Postal Code"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.country",
"title": "Country"
},
{
"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": "VOSS-AUS-Sydney",
"preferredLanguage": "en_AU",
"notes": "Added 23 October 2023",
"longitude": 151.2108,
"hierarchy": "6130d69ae04a4a0015a93bc6",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81NjZmZTE4My1hZThhLTQ1OGMtYjNjMi1lZDUzMWU0MjE2Yzk",
"address": {
"city": "Sydney",
"address1": "L19, 33 Alfred St and 50 Bridge St",
"address2": "Circular Quay",
"state": "AU-NSW",
"country": "AU",
"postalCode": "2001"
},
"latitude": -33.8613,
"timeZone": "Australia/Sydney",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMyNDVhNGNkLThmNGMtNDUwNy1hNDRjLTJmYzk0MWRhODVjOQ",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e040dd6fd4534903e05b45",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "MW-Lilongwe",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "65e040e06fd4534903e05b98",
"href": "/api/data/HierarchyNode/65e040e06fd4534903e05b98"
}
],
"self": [
{
"pkid": "65e040dd6fd4534903e05b45",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e032dd6fd4534903dff71c",
"href": "/api/v0/data/Spark/65e032dd6fd4534903dff71c"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e040dd6fd4534903e05b45/?hierarchy=[hierarchy]&model_type=device/spark/Location",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/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/Location/65e040dd6fd4534903e05b45/+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/Location/65e040dd6fd4534903e05b45/+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/Location/65e040dd6fd4534903e05b45/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"fetch_floors": {
"support_async": true,
"class": "custom",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/+fetch_floors/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Fetch Floors"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Location/65e040dd6fd4534903e05b45/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Location",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e040e06fd4534903e05b98",
"65e040dd6fd4534903e05b45"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "preferredLanguage",
"title": "Preferred Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.city",
"title": "City"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address1",
"title": "Address Line 1"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.address2",
"title": "Address Line 2"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.state",
"title": "State"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.postalCode",
"title": "Postal Code"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "address.country",
"title": "Country"
},
{
"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": "MW-Lilongwe",
"preferredLanguage": "en_US",
"longitude": 18.5202187,
"hierarchy": "5f3ae552ce894e00120537fa",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9mOTYwOWM5MS03MDkxLTQyZmYtYmQ2YS04ZWEzOTQxNWExZmE",
"address": {
"city": "Cape Town",
"address1": "3 Waterhouse Pl, Century City, Cape Town, 7441, South Africa",
"address2": "",
"state": "ZA-WC",
"country": "ZA",
"postalCode": "7441"
},
"latitude": -33.8886324,
"timeZone": "Africa/Johannesburg",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc1NGQ1NDU1LTBkNzYtNDg3MS1hOTRmLWJhOTFiYjE2ZGNjZQ"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/Location. | GET | /api/device/spark/Location/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/Location as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/spark/Location/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/spark/Location/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/spark/Location/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/Location | 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/Location; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/Location/[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/Location and the JSON format can be used to import instances of device/spark/Location.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/Location/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/Location/[pkid] | hierarchy=[hierarchy] | The device/spark/Location instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/Location/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/Location. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Fetch Floors | POST | /api/device/spark/Location/[pkid]/+fetch_floors | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/Location/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |