[Index]
Model ref.: device/spark/CallParkGroup
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": {
"callParkExtensions": {
"description": "Manage the park destinations where this group parks calls",
"title": "Park Destinations",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A unique name for the call park extension",
"title": "Name"
},
"extension": {
"type": "string",
"description": "The extension for the call park",
"title": "Extension"
},
"id": {
"type": "string",
"title": "Id"
}
}
},
"required": false,
"readonly": true,
"type": "array"
},
"name": {
"readonly": true,
"required": true,
"type": "string",
"title": "Name"
},
"recall": {
"properties": {
"huntGroupId": {
"type": "string",
"description": "hunt group ID for call park recall alternate destination",
"title": "HuntGroup ID"
},
"huntGroupName": {
"description": "Unique name for the hunt group",
"format": "uri",
"title": "HuntGroup Name",
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/HuntGroup",
"type": "string",
"target": "/api/device/spark/HuntGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"option": {
"title": "Option",
"enum": [
"ALERT_PARKING_USER_ONLY",
"ALERT_PARKING_USER_FIRST_THEN_HUNT_GROUP",
"ALERT_HUNT_GROUP_ONLY"
],
"type": "string",
"description": "Call park recall options",
"choices": [
{
"value": "ALERT_PARKING_USER_ONLY",
"title": "Only alert the parking user"
},
{
"value": "ALERT_PARKING_USER_FIRST_THEN_HUNT_GROUP",
"title": "Alert the parking user first, then the hunt group"
},
{
"value": "ALERT_HUNT_GROUP_ONLY",
"title": "Alert hunt group only"
}
]
}
},
"required": false,
"type": "object",
"description": "If the users assigned in the previous step do not pick up the call that is parked, then the call is rerouted/recalled to the following options based on the selection here",
"title": "Recall To"
},
"id": {
"type": "string",
"title": "id"
},
"locationName": {
"readonly": true,
"type": "string",
"title": "Location"
},
"parkOnAgentsEnabled": {
"readonly": true,
"type": "boolean",
"description": "The member list is configured as park destination list for this call park group. Deselect to add Call Park Extensions",
"title": "Use Members as Park Destinations"
},
"locationId": {
"target": "/api/device/spark/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Location",
"title": "locationId",
"type": "string"
},
"agents": {
"items": {
"type": "object",
"properties": {
"displayName": {
"readonly": true,
"type": "string",
"description": "Display name of a person, workspace or virtual line",
"title": "Display Name"
},
"firstName": {
"readonly": true,
"type": "string",
"description": "First name of a person, workspace or virtual line",
"title": "First Name"
},
"lastName": {
"readonly": true,
"type": "string",
"description": "Last name of a person, workspace or virtual line",
"title": "Last Name"
},
"email": {
"readonly": true,
"type": "string",
"description": "Email of a person, workspace or virtual line",
"title": "Email"
},
"numbers": {
"description": "List of phone numbers of a person, workspace or virtual line",
"title": "Numbers",
"items": {
"type": "object",
"properties": {
"external": {
"type": "string",
"description": "Phone number of a person or workspace",
"title": "External"
},
"extension": {
"type": "string",
"description": "Extension of a person or workspace",
"title": "Extension"
},
"primary": {
"type": "boolean",
"description": "Flag to indicate a primary phone",
"title": "Primary"
}
}
},
"required": false,
"readonly": true,
"type": "array"
},
"type": {
"readonly": true,
"enum": [
"PEOPLE",
"PLACE",
"VIRTUAL_LINE"
],
"type": "string",
"description": "Type of the person, workspace or virtual line",
"title": "Type"
},
"id": {
"description": "id",
"format": "uri",
"title": "Agent",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/User",
"type": "string",
"target": "/api/device/spark/User/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"required": false,
"type": "array",
"description": "People, workspaces and virtual lines that are eligible to receive calls",
"title": "Agents"
},
"parkgrp_id": {
"type": "string",
"title": "parkgrp_key"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/spark/CallParkGroup/add/ |
|
The GUI Add form of device/spark/CallParkGroup 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/CallParkGroup | 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/device/spark/CallParkGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/spark/CallParkGroup/[pkid1]", "/api/device/spark/CallParkGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/spark/CallParkGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/spark/CallParkGroup/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/spark/CallParkGroup/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/CallParkGroup/[pkid1]", "/api/v0/device/spark/CallParkGroup/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/spark/CallParkGroup/?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/CallParkGroup |
|
{"hrefs": ["/api/device/spark/CallParkGroup/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/CallParkGroup |
|
{"hrefs": ["/api/device/spark/CallParkGroup/[pkid1]", "/api/device/spark/CallParkGroup/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/CallParkGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/CallParkGroup/export/ |
|
{ "hrefs":["/api/device/spark/CallParkGroup/[pkid1]", "/api/device/spark/CallParkGroup/[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/CallParkGroup and the JSON format can be used to import instances of device/spark/CallParkGroup.
GET http://[host-proxy]/api/device/spark/CallParkGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/CallParkGroup | POST | /api/device/spark/CallParkGroup/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/CallParkGroup/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/CallParkGroup/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/CallParkGroup/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/CallParkGroup/ |
|
The device/spark/CallParkGroup schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/CallParkGroup instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/CallParkGroup/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 17
},
"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/CallParkGroup/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/CallParkGroup/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/spark/CallParkGroup/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/CallParkGroup",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallParkGroup/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/CallParkGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/CallParkGroup/+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/CallParkGroup/+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/CallParkGroup/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/CallParkGroup/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/spark/CallParkGroup/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/CallParkGroup/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/CallParkGroup/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallParkGroup/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/spark/CallParkGroup/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/spark/CallParkGroup",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"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": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.option",
"title": "Option"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.huntGroupName",
"title": "HuntGroup 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": "65e037ed6fd4534903e04d88",
"meta": {
"tags": [],
"cached": true,
"title": "Auto_CallPark_Group",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e032dd6fd4534903dff71c",
"href": "/api/v0/data/Spark/65e032dd6fd4534903dff71c"
}
],
"self": [
{
"pkid": "65e037ed6fd4534903e04d88",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e037ed6fd4534903e04d88/?model_type=device/spark/CallParkGroup",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallParkGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e037ed6fd4534903e04d88"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.option",
"title": "Option"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.huntGroupName",
"title": "HuntGroup 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": "Auto_CallPark_Group",
"recall": {
"huntGroupId": "",
"huntGroupName": "",
"option": "ALERT_PARKING_USER_ONLY"
},
"parkgrp_id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RWFYwYjE5RFlXeHNVR0Z5YTE5SGNtOTFjQT09:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzNlOTBkNzA5LWM4MGEtNGIxYi1iYWUxLTFmNTczYTI3MzhjNA:Site2",
"locationName": "Site2",
"parkOnAgentsEnabled": true,
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzNlOTBkNzA5LWM4MGEtNGIxYi1iYWUxLTFmNTczYTI3MzhjNA",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Connection parameters for Spark Customer AB_Group, AB_Group, hcs.CS-P.CS-AB.AB_Group",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RWFYwYjE5RFlXeHNVR0Z5YTE5SGNtOTFjQT09",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "65e0a1d96fd4534903e4fd1d",
"meta": {
"tags": [],
"cached": true,
"title": "CallPark4",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1d96fd4534903e4fd1d",
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1d96fd4534903e4fd1d/?model_type=device/spark/CallParkGroup",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/CallParkGroup/65e0a1d96fd4534903e4fd1d/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/CallParkGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1d96fd4534903e4fd1d"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.option",
"title": "Option"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.huntGroupName",
"title": "HuntGroup 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": "CallPark4",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"recall": {
"huntGroupId": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWW5Ga2RtOXRaV1JsYlVBNU9EQXlOek0yT1M1MWN6RXdMbUpqYkdRdWQyVmlaWGd1WTI5dA",
"huntGroupName": "VOSS-GBR-Reading-GS-HG-1",
"option": "ALERT_HUNT_GROUP_ONLY"
},
"parkgrp_id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RMkZzYkZCaGNtczA:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYTc3MGIyLTU3OGMtNGI5Zi04N2RjLTJkMzkyZGEyZGVjZQ:VOSS-GBR-Reading",
"locationName": "VOSS-GBR-Reading",
"parkOnAgentsEnabled": true,
"locationId": "VOSS-GBR-Reading",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RMkZzYkZCaGNtczA",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0a1d66fd4534903e4fcc3",
"meta": {
"tags": [],
"cached": true,
"title": "CallPark5",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1d66fd4534903e4fcc3",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e0a1d66fd4534903e4fcc3/?model_type=device/spark/CallParkGroup",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/CallParkGroup/65e0a1d66fd4534903e4fcc3/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallParkGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1d66fd4534903e4fcc3"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.option",
"title": "Option"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.huntGroupName",
"title": "HuntGroup 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": "CallPark5",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"recall": {
"huntGroupId": "",
"huntGroupName": "",
"option": "ALERT_PARKING_USER_ONLY"
},
"parkgrp_id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RMkZzYkZCaGNtczE:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYTc3MGIyLTU3OGMtNGI5Zi04N2RjLTJkMzkyZGEyZGVjZQ:VOSS-GBR-Reading",
"locationName": "VOSS-GBR-Reading",
"parkOnAgentsEnabled": true,
"locationId": "VOSS-GBR-Reading",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RMkZzYkZCaGNtczE",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e037ed6fd4534903e04d88",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Auto_CallPark_Group",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "65e037ed6fd4534903e04d88",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/"
}
],
"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/CallParkGroup/65e037ed6fd4534903e04d88/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e037ed6fd4534903e04d88/?hierarchy=[hierarchy]&model_type=device/spark/CallParkGroup",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/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/CallParkGroup/65e037ed6fd4534903e04d88/+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/CallParkGroup/65e037ed6fd4534903e04d88/+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/CallParkGroup/65e037ed6fd4534903e04d88/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/CallParkGroup/65e037ed6fd4534903e04d88/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/CallParkGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e037ed6fd4534903e04d88"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.option",
"title": "Option"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "recall.huntGroupName",
"title": "HuntGroup 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": "Auto_CallPark_Group",
"recall": {
"huntGroupId": "",
"huntGroupName": "",
"option": "ALERT_PARKING_USER_ONLY"
},
"parkgrp_id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RWFYwYjE5RFlXeHNVR0Z5YTE5SGNtOTFjQT09:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzNlOTBkNzA5LWM4MGEtNGIxYi1iYWUxLTFmNTczYTI3MzhjNA:Site2",
"locationName": "Site2",
"parkOnAgentsEnabled": true,
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzNlOTBkNzA5LWM4MGEtNGIxYi1iYWUxLTFmNTczYTI3MzhjNA",
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9RWFYwYjE5RFlXeHNVR0Z5YTE5SGNtOTFjQT09"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/CallParkGroup. | GET | /api/device/spark/CallParkGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/CallParkGroup as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/spark/CallParkGroup/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/spark/CallParkGroup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/spark/CallParkGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/spark/CallParkGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/CallParkGroup | 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/CallParkGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/CallParkGroup/[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/CallParkGroup and the JSON format can be used to import instances of device/spark/CallParkGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/CallParkGroup/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/CallParkGroup/[pkid] | hierarchy=[hierarchy] | The device/spark/CallParkGroup instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/CallParkGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/CallParkGroup. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/CallParkGroup/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |