Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/SupportedDevices; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/spark/SupportedDevices/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/spark/SupportedDevices/[pkid1]", "/api/device/spark/SupportedDevices/[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/SupportedDevices and the JSON format can be used to import instances of device/spark/SupportedDevices.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/spark/SupportedDevices:

 GET http://[host-proxy]/api/device/spark/SupportedDevices/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/spark/SupportedDevices/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/spark/SupportedDevices/	hierarchy=[hierarchy] format=json schema=true	The device/spark/SupportedDevices schema and all instances as JSON.

(The list will return 0 to 3 device/spark/SupportedDevices instances)

GET http://[host]/api/device/spark/SupportedDevices/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "displayName",
          "direction": "asc",
          "current": "/api/device/spark/SupportedDevices/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=down"
     },
     "operations": [
          "list"
     ],
     "meta": {
          "model_type": "device/spark/SupportedDevices",
          "summary_attrs": [
               {
                    "name": "displayName",
                    "title": "displayName"
               },
               {
                    "name": "model",
                    "title": "model"
               },
               {
                    "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": []
          },
          "model_specific_actions": [
               "list",
               "get",
               "export",
               "field_display_policy"
          ],
          "schema_version": "1.0.0",
          "actions": [
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/spark/SupportedDevices/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/spark/SupportedDevices/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/spark/SupportedDevices/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/spark/SupportedDevices/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/spark/SupportedDevices/purge/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/spark/SupportedDevices; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/spark/SupportedDevices/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/SupportedDevices and the JSON format can be used to import instances of device/spark/SupportedDevices.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/spark/SupportedDevices/[pkid]	hierarchy=[hierarchy]	The device/spark/SupportedDevices instance with [pkid].

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/spark/SupportedDevices/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/spark/SupportedDevices

GET http://[host-proxy]/api/device/spark/SupportedDevices/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Export

Field Display Policy

List

GET http://[host]/api/device/spark/SupportedDevices/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Purge

Instance API Reference

Export

Get

Purge