[Index]
Configuration for various system monitoring settings and thresholds for alert generation.
Model ref.: data/SystemMonitoringConfig
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": {
"alerts": {
"properties": {
"transactions": {
"properties": {
"queue_size": {
"minimum": 0,
"type": "integer",
"description": "The threshold at which transaction queue size starts generating notifications.",
"title": "Transaction Queue Size Threshold"
},
"on_failure": {
"items": {
"type": "object",
"properties": {
"operations": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"required": true,
"type": "array",
"description": "The operations for which alerts are required",
"title": "Operations"
},
"entity_type": {
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Entity Type",
"format": "uri",
"choices": [],
"target_model_type": "",
"type": "string",
"description": "Type of an entity for which an alert is required such as model, view, or tool. Wildcards are permitted e.g. data/* applies to all data models. Specific types take precedence over wildcards"
}
}
},
"type": "array",
"description": "List of transactions for which an alert must be sent on failure.",
"title": "On Failure"
},
"max_queued_time": {
"description": "Elapsed time after which 'Queued' transactions generate notifications.",
"title": "Maximum time in 'Queued' state (hours)",
"default": 6,
"maximum": 48,
"minimum": 1,
"type": "integer"
},
"max_processing_time": {
"description": "Elapsed time from last update after which 'Processing' transactions generate notifications.",
"title": "Maximum time in 'Processing' state (hours)",
"default": 6,
"maximum": 48,
"minimum": 1,
"type": "integer"
}
},
"type": "object",
"description": "Specifies configuration for alert generation on transactions.",
"title": "Transactions"
},
"database": {
"properties": {
"total_size": {
"minimum": 0,
"type": "integer",
"description": "The threshold at which DB size (in gigabytes) starts generating notifications.",
"title": "Database Size Threshold (GB)"
},
"total_index_size": {
"minimum": 0,
"type": "integer",
"description": "The threshold at which DB index size (in gigabytes) starts generating notifications.",
"title": "Database Index Size Threshold (GB)"
}
},
"type": "object",
"description": "Stores thresholds for database metrics",
"title": "Database"
}
},
"type": "object",
"description": "Configuration for various alert generation conditions.",
"title": "Alerts"
},
"name": {
"title": "Name",
"required": true,
"type": "string",
"maxLength": 64
},
"metric_configuration": {
"properties": {
"monitor_external_devices": {
"type": "boolean",
"description": "Enable monitoring of connectivity to external devices e.g. UC apps",
"title": "Monitor external devices"
},
"risapi_collector_interval": {
"type": "integer",
"description": "Interval in seconds between attempts to run the RIS API data collector",
"title": "RIS API data collector interval"
},
"risapi_excluded_device_types": {
"items": {
"type": "string"
},
"type": "array",
"description": "Devices to ignore in RIS API responses",
"title": "RIS API excluded device types"
},
"resource_count_by_hierarchy": {
"properties": {
"model_types": {
"items": {
"type": "object",
"properties": {
"model_type": {
"type": "string",
"description": "Name of a model type e.g. data/User",
"title": "Model Type"
}
}
},
"type": "array",
"description": "List of model types that are to be aggregated by hierarchy.",
"title": "Model Types"
}
},
"type": "object",
"description": "Settings for Resource Count by Hierarchy metric.",
"title": "Resource Count by Hierarchy"
}
},
"type": "object",
"description": "Stores settings for configurable metrics",
"title": "Metric Configuration"
}
},
"schema_version": "1.5.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/SystemMonitoringConfig/add/ |
|
The GUI Add form of data/SystemMonitoringConfig 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/SystemMonitoringConfig/ | 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/SystemMonitoringConfig/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SystemMonitoringConfig/[pkid1]", "/api/data/SystemMonitoringConfig/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SystemMonitoringConfig/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SystemMonitoringConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SystemMonitoringConfig/export/ |
|
{ "hrefs":["/api/data/SystemMonitoringConfig/[pkid1]", "/api/data/SystemMonitoringConfig/[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/SystemMonitoringConfig and the JSON format can be used to import instances of data/SystemMonitoringConfig.
GET http://[host-proxy]/api/data/SystemMonitoringConfig/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/SystemMonitoringConfig/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/SystemMonitoringConfig/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/SystemMonitoringConfig/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/SystemMonitoringConfig/ |
|
The data/SystemMonitoringConfig schema and all instances as JSON. |
(The list will return 0 to 3 data/SystemMonitoringConfig instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/SystemMonitoringConfig/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "1.5.4",
"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/SystemMonitoringConfig/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/SystemMonitoringConfig/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/SystemMonitoringConfig/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/SystemMonitoringConfig/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/SystemMonitoringConfig/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/SystemMonitoringConfig/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/SystemMonitoringConfig/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/SystemMonitoringConfig/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/data/SystemMonitoringConfig/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "data/SystemMonitoringConfig",
"model_specific_actions": [
"add",
"update",
"export",
"field_display_policy",
"configuration_template",
"get",
"help",
"list",
"migration",
"transform",
"remove"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6304f7994efbec3d13c62b05",
"meta": {
"tags": [
"base",
"core"
],
"cached": true,
"title": "Global",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "1.5.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6304f7994efbec3d13c62b05",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/SystemMonitoringConfig",
"path": [
"6t0ggef2c0deab00hb595101",
"6304f7994efbec3d13c62b05"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Global",
"pkid": "6304f7994efbec3d13c62b06",
"alerts": {
"transactions": {
"queue_size": 500,
"on_failure": [
{
"operations": [
"import"
],
"entity_type": "data/*"
}
]
},
"database": {
"total_size": 200,
"total_index_size": 50
}
},
"hierarchy_friendly_name": "sys (System)",
"metric_configuration": {
"risapi_collector_interval": 43200,
"risapi_excluded_device_types": [
"642"
],
"resource_count_by_hierarchy": {
"model_types": [
{
"model_type": "device/cucm/CallPickupGroup"
},
{
"model_type": "device/uccx/Agent"
},
{
"model_type": "device/uccx/Team"
},
{
"model_type": "device/uccx/ContactServiceQueue"
},
{
"model_type": "device/uccx/ResourceGroup"
},
{
"model_type": "data/BaseSiteDAT"
},
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/Phone"
},
{
"model_type": "device/cucm/HuntPilot"
},
{
"model_type": "data/InternalNumberInventory"
},
{
"model_type": "data/HcsDpE164InventoryDAT"
},
{
"model_type": "device/cucm/Line"
},
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/DeviceProfile"
},
{
"model_type": "device/cuc/User"
},
{
"model_type": "device/spark/User"
}
]
}
},
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "6304f7994efbec3d13c62b05",
"meta": {
"tags": [
"base",
"core"
],
"cached": false,
"title": "Global",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "1.5.4",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "6304f7994efbec3d13c62b05",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/SystemMonitoringConfig/6304f7994efbec3d13c62b05/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/SystemMonitoringConfig",
"path": [
"6t0ggef2c0deab00hb595101",
"6304f7994efbec3d13c62b05"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6304f7994efbec3d13c62b06",
"alerts": {
"database": {
"total_size": 200,
"total_index_size": 50
},
"transactions": {
"queue_size": 500,
"on_failure": [
{
"operations": [
"import"
],
"entity_type": "data/*"
}
]
}
},
"name": "Global",
"metric_configuration": {
"resource_count_by_hierarchy": {
"model_types": [
{
"model_type": "device/cucm/CallPickupGroup"
},
{
"model_type": "device/uccx/Agent"
},
{
"model_type": "device/uccx/Team"
},
{
"model_type": "device/uccx/ContactServiceQueue"
},
{
"model_type": "device/uccx/ResourceGroup"
},
{
"model_type": "data/BaseSiteDAT"
},
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/Phone"
},
{
"model_type": "device/cucm/HuntPilot"
},
{
"model_type": "data/InternalNumberInventory"
},
{
"model_type": "data/HcsDpE164InventoryDAT"
},
{
"model_type": "device/cucm/Line"
},
{
"model_type": "device/cucm/User"
},
{
"model_type": "device/cucm/DeviceProfile"
},
{
"model_type": "device/cuc/User"
},
{
"model_type": "device/spark/User"
}
]
},
"risapi_excluded_device_types": [
"642"
],
"risapi_collector_interval": 43200
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/SystemMonitoringConfig. | GET | /api/data/SystemMonitoringConfig/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SystemMonitoringConfig as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/SystemMonitoringConfig/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/SystemMonitoringConfig/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/SystemMonitoringConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/SystemMonitoringConfig/[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/SystemMonitoringConfig and the JSON format can be used to import instances of data/SystemMonitoringConfig.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/SystemMonitoringConfig/[pkid]/ | hierarchy=[hierarchy] | The data/SystemMonitoringConfig instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/SystemMonitoringConfig/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SystemMonitoringConfig. |