[Index]
Used (per device) for configuring the change notification collector process & for monitoring unprocessed change notifications
Model ref.: data/DeviceChanges
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": {
"device_id": {
"description": "The resource ID of the associated device",
"title": "Device ID",
"required": true,
"readonly": true,
"type": "string"
},
"device_name": {
"required": true,
"type": "string",
"description": "The name of the associated device",
"title": "Device Name"
},
"device_type": {
"description": "The type of the associated device",
"title": "Device Type",
"required": true,
"readonly": true,
"type": "string"
},
"last_collection_time": {
"readonly": true,
"type": "string",
"description": "The last time the associated device was checked for changes",
"title": "Last Collection Time"
},
"notes": {
"description": "CUCM Cluster Notes Field",
"title": "CUCM Cluster Notes",
"required": false,
"readonly": false,
"type": "string"
},
"changes": {
"description": "Pending changes for the associated device",
"title": "Pending Change Notifications",
"items": {
"type": "object",
"properties": {
"model_type": {
"description": "The model type of the pending changes in this section",
"title": "Model Type",
"required": true,
"readonly": true,
"type": "string"
},
"add_count": {
"readonly": true,
"type": "integer",
"description": "The number of pending add changes ",
"title": "Add Count"
},
"update_count": {
"readonly": true,
"type": "integer",
"description": "The number of pending update changes ",
"title": "Update Count"
},
"delete_count": {
"readonly": true,
"type": "integer",
"description": "The number of pending delete changes ",
"title": "Delete Count"
}
}
},
"readonly": true,
"type": "array"
},
"settings": {
"type": "object",
"description": "Change collector settings for this device",
"title": "Settings",
"properties": {
"polling_interval": {
"description": "How often the change collector service will check this device for changes (seconds)",
"title": "Polling Interval (seconds)",
"default": 300,
"maximum": 7200,
"minimum": 300,
"type": "integer"
},
"cnf_enabled": {
"default": true,
"type": "boolean",
"description": "Tick to enable change collection for this device",
"title": "Enable Change Collection"
},
"model_type_list": {
"target": "/api/data/ModelTypeList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Model Type List",
"target_attr": "name",
"type": "string",
"description": "Reference to a list of model types to be included or excluded for change collection.",
"target_model_type": "data/ModelTypeList",
"choices": []
},
"ignored_operations": {
"description": "Indicates which operations should not be collected.",
"title": "Ignored Operations",
"required": false,
"type": "object",
"properties": {
"add": {
"required": false,
"type": "boolean",
"description": "Do not collect \"add\" changes.",
"title": "Add"
},
"update": {
"required": false,
"type": "boolean",
"description": "Do not collect \"update\" changes.",
"title": "Update"
},
"remove": {
"required": false,
"type": "boolean",
"description": "Do not collect \"remove\" changes.",
"title": "Remove"
}
}
},
"displayed_model_types": {
"items": {
"type": "object",
"properties": {
"model_type": {
"type": "string",
"description": "The model type that will have counts displayed in the pending changes section",
"title": "Model Type"
}
}
},
"type": "array",
"description": "These model types will be displayed un-grouped in the pending changes section",
"title": "Displayed Model Types"
}
}
}
},
"schema_version": "0.8"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DeviceChanges/add/ |
|
The GUI Add form of data/DeviceChanges 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/DeviceChanges | 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/DeviceChanges/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DeviceChanges/[pkid1]", "/api/data/DeviceChanges/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DeviceChanges/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DeviceChanges; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DeviceChanges/export/ |
|
{ "hrefs":["/api/data/DeviceChanges/[pkid1]", "/api/data/DeviceChanges/[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/DeviceChanges and the JSON format can be used to import instances of data/DeviceChanges.
GET http://[host-proxy]/api/data/DeviceChanges/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DeviceChanges/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/DeviceChanges/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DeviceChanges/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DeviceChanges/ |
|
The data/DeviceChanges schema and all instances as JSON. |
(The list will return 0 to 3 data/DeviceChanges instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "device_name",
"direction": "asc",
"current": "/api/data/DeviceChanges/?skip=0&limit=3&order_by=device_name&direction=asc&traversal=down"
},
"operations": [
"help",
"bulk_update_form",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"migration",
"remove",
"move",
"transform",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "data/DeviceChanges",
"summary_attrs": [
{
"name": "device_name",
"title": "Device Name"
},
{
"name": "notes",
"title": "CUCM Cluster Notes"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"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": [
"add",
"export",
"get",
"help",
"list",
"remove",
"tag",
"tag_version",
"field_display_policy",
"update"
],
"schema_version": "0.8",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DeviceChanges/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceChanges/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/DeviceChanges/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceChanges/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DeviceChanges/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/DeviceChanges/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DeviceChanges/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceChanges/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"settings": {
"displayed_model_types": [
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/Phone"
},
{
"model_type": "device/cucm/Line"
}
],
"cnf_enabled": false,
"polling_interval": 300
},
"pkid": "5df0b694ce894e001275c11d",
"notes": "abg-cl1-p",
"device_name": "[\"192.168.100.15\", \"8443\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"device_type": "data/CallManager",
"device_id": "5df0b693ce894e001275c115",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/DeviceChanges",
"summary_attrs": [
{
"name": "device_name",
"title": "Device Name"
},
{
"name": "notes",
"title": "CUCM Cluster Notes"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "[\"192.168.100.15\", \"8443\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [
{
"pkid": "5df0b693ce894e001275c115",
"path": "device_name",
"model_type": "data/CallManager"
}
],
"self": [
{
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/",
"pkid": "5df0b694ce894e001275c11c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b694ce894e001275c11c"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b694ce894e001275c11c"
}
]
}
(Show the first instance)
{
"data": {
"settings": {
"displayed_model_types": [
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/Phone"
},
{
"model_type": "device/cucm/Line"
}
],
"cnf_enabled": false,
"polling_interval": 300
},
"notes": "abg-cl1-p",
"device_name": "[\"192.168.100.15\", \"8443\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"device_type": "data/CallManager",
"device_id": "5df0b693ce894e001275c115",
"changes": [
{
"add_count": 0,
"delete_count": 0,
"update_count": 0,
"model_type": "device/cucm/User"
},
{
"add_count": 0,
"delete_count": 0,
"update_count": 0,
"model_type": "device/cucm/Phone"
},
{
"add_count": 0,
"delete_count": 0,
"update_count": 0,
"model_type": "device/cucm/Line"
}
],
"last_collection_time": "2019-12-11T11:27:50.828000",
"pkid": "5df0b694ce894e001275c11d"
},
"meta": {
"model_type": "data/DeviceChanges",
"summary_attrs": [
{
"name": "device_name",
"title": "Device Name"
},
{
"name": "notes",
"title": "CUCM Cluster Notes"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "[\"192.168.100.15\", \"8443\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"business_key": {},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913",
"pkid": "5df0b66bce894e001275a913"
}
],
"foreign_key": [
{
"pkid": "5df0b693ce894e001275c115",
"path": "device_name",
"model_type": "data/CallManager"
}
],
"children": [],
"self": [
{
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/",
"pkid": "5df0b694ce894e001275c11c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b694ce894e001275c11c"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceChanges/5df0b694ce894e001275c11c/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5df0b694ce894e001275c11c"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DeviceChanges. | GET | /api/data/DeviceChanges/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DeviceChanges as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DeviceChanges/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DeviceChanges/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/DeviceChanges; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DeviceChanges/[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/DeviceChanges and the JSON format can be used to import instances of data/DeviceChanges.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DeviceChanges/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DeviceChanges/[pkid] | hierarchy=[hierarchy] | The data/DeviceChanges instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DeviceChanges/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DeviceChanges. |