[Index]
HcsDeviceGroupDAT
Model ref.: data/HcsDeviceGroupDAT
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": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"devices": {
"is_password": false,
"title": "Devices",
"minItems": 0,
"items": {
"is_password": false,
"type": "string",
"choices": [
{
"value": " ",
"title": " "
}
]
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsDeviceGroupDAT/add/ |
|
The GUI Add form of data/HcsDeviceGroupDAT 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/data/HcsDeviceGroupDAT/ | 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/data/HcsDeviceGroupDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsDeviceGroupDAT/[pkid1]", "/api/data/HcsDeviceGroupDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsDeviceGroupDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsDeviceGroupDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsDeviceGroupDAT/export/ |
|
{ "hrefs":["/api/data/HcsDeviceGroupDAT/[pkid1]", "/api/data/HcsDeviceGroupDAT/[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 data/HcsDeviceGroupDAT and the JSON format can be used to import instances of data/HcsDeviceGroupDAT.
GET http://[host-proxy]/api/data/HcsDeviceGroupDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsDeviceGroupDAT | POST | /api/data/HcsDeviceGroupDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsDeviceGroupDAT/ |
|
The data/HcsDeviceGroupDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsDeviceGroupDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsDeviceGroupDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.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/data/HcsDeviceGroupDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDeviceGroupDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDeviceGroupDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsDeviceGroupDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsDeviceGroupDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDeviceGroupDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDeviceGroupDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6305a300c46e74b4688712a0",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305a300c46e74b4688712a0",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/"
}
],
"parent": [
{
"pkid": "63054bfdc46e74b4687bb868",
"href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDeviceGroupDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"6305a300c46e74b4688712a0"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "Only devices from the 88xx series",
"pkid": "6305a300c46e74b4688712a1",
"devices": [
"Cisco 8831",
"Cisco 8841",
"Cisco 8851",
"Cisco 8861"
],
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P",
"name": "88xx Series"
}
},
{
"pkid": "63055a24c46e74b4687f0cbf",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "63055a24c46e74b4687f0cbf",
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/"
}
],
"parent": [
{
"pkid": "63054bfdc46e74b4687bb868",
"href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/execute/",
"title": "Execute",
"class": "execute",
"method": "POST"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/HcsDeviceGroupDAT/63055a24c46e74b4687f0cbf/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/HcsDeviceGroupDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63055a24c46e74b4687f0cbf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "RST Device Group",
"pkid": "63055a24c46e74b4687f0cc0",
"devices": [
"Analog Phone",
"BEKEM 36-Button Line Expansion Module",
"C881V",
"Carrier-integrated Mobile",
"Cisco 12 S",
"Cisco 12 SP",
"Cisco 12 SP+",
"Cisco 30 SP+",
"Cisco 30 VIP",
"Cisco 3905",
"Cisco 3911",
"Cisco 3951",
"Cisco 6901",
"Cisco 6911",
"Cisco 6921",
"Cisco 6941",
"Cisco 6945",
"Cisco 6961",
"Cisco 7821",
"Cisco 7841",
"Cisco 7861",
"Cisco 7902",
"Cisco 7905",
"Cisco 7906",
"Cisco 7910",
"Cisco 7911",
"Cisco 7912",
"Cisco 7920",
"Cisco 7921",
"Cisco 7925",
"Cisco 7926",
"Cisco 7931",
"Cisco 7935",
"Cisco 7936",
"Cisco 7937",
"Cisco 7940",
"Cisco 7941",
"Cisco 7941G-GE",
"Cisco 7942",
"Cisco 7945",
"Cisco 7960",
"Cisco 7961",
"Cisco 7961G-GE",
"Cisco 7962",
"Cisco 7965",
"Cisco 7970",
"Cisco 7971",
"Cisco 7975",
"Cisco 7985",
"Cisco 8831",
"Cisco 8841",
"Cisco 8851",
"Cisco 8861",
"Cisco 8941",
"Cisco 8945",
"Cisco 8961",
"Cisco 9951",
"Cisco 9971",
"Cisco ATA 186",
"Cisco ATA 187",
"Cisco Cius",
"Cisco Cius SP",
"Cisco Dual Mode for Android",
"Cisco Dual Mode for iPhone",
"Cisco DX650",
"Cisco DX70",
"Cisco DX80",
"Cisco E20",
"Cisco IP Communicator",
"Cisco ISR 4431",
"Cisco Jabber for Tablet",
"Cisco TelePresence",
"Cisco TelePresence 1000",
"Cisco TelePresence 1100",
"Cisco TelePresence 1300-47",
"Cisco TelePresence 1300-65",
"Cisco TelePresence 200",
"Cisco TelePresence 3000",
"Cisco TelePresence 3200",
"Cisco TelePresence 400",
"Cisco TelePresence 500-32",
"Cisco TelePresence 500-37",
"Cisco TelePresence Codec C40",
"Cisco TelePresence Codec C60",
"Cisco TelePresence Codec C90",
"Cisco TelePresence EX60",
"Cisco TelePresence EX90",
"Cisco TelePresence MX200",
"Cisco TelePresence MX200 G2",
"Cisco TelePresence MX300",
"Cisco TelePresence MX300 G2",
"Cisco TelePresence MX700",
"Cisco TelePresence MX800",
"Cisco TelePresence Profile 42 (C20)",
"Cisco TelePresence Profile 42 (C40)",
"Cisco TelePresence Profile 42 (C60)",
"Cisco TelePresence Profile 52 (C40)",
"Cisco TelePresence Profile 52 (C60)",
"Cisco TelePresence Profile 52 Dual (C60)",
"Cisco TelePresence Profile 65 (C60)",
"Cisco TelePresence Profile 65 Dual (C90)",
"Cisco TelePresence Quick Set C20",
"Cisco TelePresence SX10",
"Cisco TelePresence SX20",
"Cisco TelePresence SX80",
"Cisco TelePresence TX1310-65",
"Cisco TelePresence TX9000",
"Cisco TelePresence TX9200",
"Cisco Unified Client Services Framework",
"Cisco Unified Communications for RTX",
"Cisco Unified Mobile Communicator",
"Cisco Unified Personal Communicator",
"Cisco VGC Phone",
"Cisco VGC Virtual Phone",
"Cisco VXC 6215",
"CTI Remote Device",
"Generic Desktop Video Endpoint",
"Generic Multiple Screen Room System",
"Generic Single Screen Room System",
"IMS-integrated Mobile (Basic)",
"IP-STE",
"ISDN BRI Phone",
"Motorola CN622",
"NIM-2BRI-NT/TE",
"NIM-2BRI-NT/TE-SCCP",
"NIM-2FXO",
"NIM-2FXS",
"NIM-2FXS-SCCP",
"NIM-2FXS/4FXO",
"NIM-2FXS/4FXO-SCCP",
"NIM-4BRI-NT/TE",
"NIM-4BRI-NT/TE-SCCP",
"NIM-4FXO",
"NIM-4FXS",
"NIM-4FXS-SCCP",
"Nokia S60",
"Third-party AS-SIP Endpoint",
"Third-party SIP Device (Advanced)",
"Third-party SIP Device (Basic)",
"Transnova S3",
"Universal Device Template",
"VG-2VWIC-MBRD",
"VG-3VWIC-MBRD",
"VG310",
"VG320",
"Cisco 8865"
],
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P",
"name": "RST Device Group"
}
}
]
}
(Show the first instance)
{
"pkid": "6305a300c46e74b4688712a0",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.0",
"references": {
"parent": [
{
"pkid": "63054bfdc46e74b4687bb868",
"href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868"
}
],
"self": [
{
"pkid": "6305a300c46e74b4688712a0",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDeviceGroupDAT/6305a300c46e74b4688712a0/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDeviceGroupDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"6305a300c46e74b4688712a0"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6305a300c46e74b4688712a1",
"name": "88xx Series",
"devices": [
"Cisco 8831",
"Cisco 8841",
"Cisco 8851",
"Cisco 8861"
],
"description": "Only devices from the 88xx series"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsDeviceGroupDAT. | GET | /api/data/HcsDeviceGroupDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsDeviceGroupDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsDeviceGroupDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsDeviceGroupDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsDeviceGroupDAT/[pkid]/import/ | 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 data/HcsDeviceGroupDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsDeviceGroupDAT/[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 data/HcsDeviceGroupDAT and the JSON format can be used to import instances of data/HcsDeviceGroupDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsDeviceGroupDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsDeviceGroupDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsDeviceGroupDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsDeviceGroupDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsDeviceGroupDAT. |