[Index]
Model ref.: device/spark/CallingProfile
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": {
"id": {
"readonly": true,
"type": "string",
"title": "Id"
},
"name": {
"readonly": true,
"type": "string",
"title": "name"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/CallingProfile |
|
{"hrefs": ["/api/device/spark/CallingProfile/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/CallingProfile |
|
{"hrefs": ["/api/device/spark/CallingProfile/[pkid1]", "/api/device/spark/CallingProfile/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/CallingProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/CallingProfile/export/ |
|
{ "hrefs":["/api/device/spark/CallingProfile/[pkid1]", "/api/device/spark/CallingProfile/[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/CallingProfile and the JSON format can be used to import instances of device/spark/CallingProfile.
GET http://[host-proxy]/api/device/spark/CallingProfile/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/CallingProfile | POST | /api/device/spark/CallingProfile/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/spark/CallingProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/CallingProfile/ |
|
The device/spark/CallingProfile schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/CallingProfile instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/CallingProfile/?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": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/CallingProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallingProfile/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/CallingProfile/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/CallingProfile/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/CallingProfile/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallingProfile/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallingProfile",
"model_specific_actions": [
"list",
"get",
"move",
"export",
"export_bulkload_template",
"field_display_policy"
],
"summary_attrs": [
{
"name": "name",
"title": "name"
},
{
"name": "id",
"title": "Id"
},
{
"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": "65e092fa6fd4534903e242bb",
"meta": {
"tags": [],
"cached": true,
"title": "cpt-voss-solutions",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e092fa6fd4534903e242bb",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e092fa6fd4534903e242bb/?model_type=device/spark/CallingProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/",
"method": "GET",
"title": "Get"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallingProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e092fa6fd4534903e242bb"
],
"summary_attrs": [
{
"name": "name",
"title": "name"
},
{
"name": "id",
"title": "Id"
},
{
"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": "cpt-voss-solutions",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS85N2M2NTFhYy05YTA2LTQ2NmEtYmVmZC00YTE0YjFlZGRlMzk",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e092fd6fd4534903e242f8",
"meta": {
"tags": [],
"cached": true,
"title": "rch-voss-solutions",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e092fd6fd4534903e242f8",
"href": "/api/device/spark/CallingProfile/65e092fd6fd4534903e242f8/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e092fd6fd4534903e242f8/?model_type=device/spark/CallingProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallingProfile/65e092fd6fd4534903e242f8/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/CallingProfile/65e092fd6fd4534903e242f8/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/CallingProfile/65e092fd6fd4534903e242f8/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/CallingProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e092fd6fd4534903e242f8"
],
"summary_attrs": [
{
"name": "name",
"title": "name"
},
{
"name": "id",
"title": "Id"
},
{
"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": "rch-voss-solutions",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9hOGUxMmRkYy1lMTUzLTQyMTEtYTM3Ny1hODVjODlkYTE1MDY",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e092f86fd4534903e24285",
"meta": {
"tags": [],
"cached": true,
"title": "rdg-voss-solutions",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e092f86fd4534903e24285",
"href": "/api/device/spark/CallingProfile/65e092f86fd4534903e24285/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e092f86fd4534903e24285/?model_type=device/spark/CallingProfile",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/CallingProfile/65e092f86fd4534903e24285/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/CallingProfile/65e092f86fd4534903e24285/",
"class": "get",
"title": "Get"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/CallingProfile/65e092f86fd4534903e24285/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallingProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e092f86fd4534903e24285"
],
"summary_attrs": [
{
"name": "name",
"title": "name"
},
{
"name": "id",
"title": "Id"
},
{
"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": "rdg-voss-solutions",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS8wZWQyMDNjYS0wMjg2LTRjNDQtYWE4My1mNDUxNDJhMGQzZTY",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e092fa6fd4534903e242bb",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "cpt-voss-solutions",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "65e092fa6fd4534903e242bb",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"children": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e092fa6fd4534903e242bb/?hierarchy=[hierarchy]&model_type=device/spark/CallingProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallingProfile/65e092fa6fd4534903e242bb/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallingProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e092fa6fd4534903e242bb"
],
"summary_attrs": [
{
"name": "name",
"title": "name"
},
{
"name": "id",
"title": "Id"
},
{
"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": {
"hierarchy": "6130d69ae04a4a0015a93bc6",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS85N2M2NTFhYy05YTA2LTQ2NmEtYmVmZC00YTE0YjFlZGRlMzk",
"name": "cpt-voss-solutions"
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/CallingProfile | 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/CallingProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/CallingProfile/[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/CallingProfile and the JSON format can be used to import instances of device/spark/CallingProfile.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/CallingProfile/[pkid] | hierarchy=[hierarchy] | The device/spark/CallingProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/CallingProfile/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |