[Index]
Stores exposed aggregate results for Login Sessions Monitoring
Model ref.: data/MonitoringSessions
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": {
"interval": {
"readonly": true,
"choices": [
{
"value": "hour",
"title": "Hour"
},
{
"value": "day",
"title": "Day"
},
{
"value": "week",
"title": "Week"
},
{
"value": "month",
"title": "Month"
}
],
"type": "string",
"description": "The period over which the metric was aggregated.",
"title": "Interval"
},
"MaxUtil": {
"readonly": true,
"type": "number",
"description": "Utilization %",
"title": "Utilization %"
},
"end_ts": {
"readonly": true,
"type": "string",
"description": "The end date/time for this aggregation group.",
"title": "End"
},
"start_ts": {
"readonly": true,
"type": "string",
"description": "The start date/time for this aggregation group.",
"title": "Start"
},
"interface": {
"readonly": true,
"type": "string",
"description": "Interface",
"title": "Interface"
},
"MaxSessions": {
"readonly": true,
"type": "number",
"description": "Max Sessions",
"title": "Max Sessions"
}
},
"schema_version": "1.0.2"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/MonitoringSessions/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/MonitoringSessions/[pkid1]", "/api/data/MonitoringSessions/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/MonitoringSessions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MonitoringSessions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/MonitoringSessions/export/ |
|
{ "hrefs":["/api/data/MonitoringSessions/[pkid1]", "/api/data/MonitoringSessions/[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/MonitoringSessions and the JSON format can be used to import instances of data/MonitoringSessions.
GET http://[host-proxy]/api/data/MonitoringSessions/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/MonitoringSessions/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/MonitoringSessions/ |
|
The data/MonitoringSessions schema and all instances as JSON. |
(The list will return 0 to 3 data/MonitoringSessions 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": "interval",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/MonitoringSessions/?skip=0&limit=3&order_by=interval&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 66
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"interval",
"start_ts",
"interface"
]
},
"schema_version": "1.0.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MonitoringSessions/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MonitoringSessions/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/MonitoringSessions/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/MonitoringSessions/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MonitoringSessions/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MonitoringSessions",
"model_specific_actions": [
"remove",
"export",
"field_display_policy",
"get",
"help",
"list"
],
"summary_attrs": [
{
"name": "interval",
"title": "Interval"
},
{
"name": "start_ts",
"title": "Start"
},
{
"name": "end_ts",
"title": "End"
},
{
"name": "interface",
"title": "Interface"
},
{
"name": "MaxSessions",
"title": "Max Sessions"
},
{
"name": "MaxUtil",
"title": "Utilization %"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6305b7a8dc4478ad233ebf31",
"meta": {
"tags": [],
"cached": true,
"title": "day - 2022-08-23T00:00:00.000000Z - administration",
"business_key": {
"hierarchy": true,
"unique": [
"interval",
"start_ts",
"interface"
]
},
"schema_version": "1.0.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305b7a8dc4478ad233ebf31",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MonitoringSessions",
"path": [
"6t0ggef2c0deab00hb595101",
"6305b7a8dc4478ad233ebf31"
],
"summary_attrs": [
{
"name": "interval",
"title": "Interval"
},
{
"name": "start_ts",
"title": "Start"
},
{
"name": "end_ts",
"title": "End"
},
{
"name": "interface",
"title": "Interface"
},
{
"name": "MaxSessions",
"title": "Max Sessions"
},
{
"name": "MaxUtil",
"title": "Utilization %"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"end_ts": "2022-08-24T00:00:00.000000Z",
"pkid": "6305b7a8dc4478ad233ebf32",
"MaxUtil": 3.5,
"interval": "day",
"start_ts": "2022-08-23T00:00:00.000000Z",
"interface": "administration",
"MaxSessions": 7,
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
},
{
"pkid": "6305b7a86580d6f2d6a0387f",
"meta": {
"tags": [],
"cached": true,
"title": "day - 2022-08-23T00:00:00.000000Z - administration",
"business_key": {
"hierarchy": true,
"unique": [
"interval",
"start_ts",
"interface"
]
},
"schema_version": "1.0.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305b7a86580d6f2d6a0387f",
"href": "/api/data/MonitoringSessions/6305b7a86580d6f2d6a0387f/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"href": "/api/data/MonitoringSessions/6305b7a86580d6f2d6a0387f/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MonitoringSessions/6305b7a86580d6f2d6a0387f/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/MonitoringSessions/6305b7a86580d6f2d6a0387f/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/MonitoringSessions/6305b7a86580d6f2d6a0387f/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/MonitoringSessions",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305b7a86580d6f2d6a0387f"
],
"summary_attrs": [
{
"name": "interval",
"title": "Interval"
},
{
"name": "start_ts",
"title": "Start"
},
{
"name": "end_ts",
"title": "End"
},
{
"name": "interface",
"title": "Interface"
},
{
"name": "MaxSessions",
"title": "Max Sessions"
},
{
"name": "MaxUtil",
"title": "Utilization %"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"end_ts": "2022-08-24T00:00:00.000000Z",
"pkid": "6305b7a86580d6f2d6a03880",
"MaxUtil": 30,
"interval": "day",
"start_ts": "2022-08-23T00:00:00.000000Z",
"interface": "administration",
"MaxSessions": 3,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6305b7a8dc4478ad233ebf34",
"meta": {
"tags": [],
"cached": true,
"title": "day - 2022-08-23T00:00:00.000000Z - administration",
"business_key": {
"hierarchy": true,
"unique": [
"interval",
"start_ts",
"interface"
]
},
"schema_version": "1.0.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305b7a8dc4478ad233ebf34",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf34/"
}
],
"parent": [
{
"pkid": "630556bfc46e74b4687dd0eb",
"href": "/api/data/HierarchyNode/630556bfc46e74b4687dd0eb"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf34/",
"class": "delete",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf34/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf34/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf34/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/MonitoringSessions",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"630556bfc46e74b4687dd0eb",
"6305b7a8dc4478ad233ebf34"
],
"summary_attrs": [
{
"name": "interval",
"title": "Interval"
},
{
"name": "start_ts",
"title": "Start"
},
{
"name": "end_ts",
"title": "End"
},
{
"name": "interface",
"title": "Interface"
},
{
"name": "MaxSessions",
"title": "Max Sessions"
},
{
"name": "MaxUtil",
"title": "Utilization %"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"end_ts": "2022-08-24T00:00:00.000000Z",
"pkid": "6305b7a8dc4478ad233ebf35",
"MaxUtil": 10,
"interval": "day",
"start_ts": "2022-08-23T00:00:00.000000Z",
"interface": "administration",
"MaxSessions": 1,
"hierarchy_friendly_name": "NBIcorp (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.NBIcorp"
}
}
]
}
(Show the first instance)
{
"pkid": "6305b7a8dc4478ad233ebf31",
"meta": {
"tags": [],
"cached": false,
"title": "day - 2022-08-23T00:00:00.000000Z - administration",
"business_key": {
"hierarchy": true,
"unique": [
"interval",
"start_ts",
"interface"
]
},
"schema_version": "1.0.2",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "6305b7a8dc4478ad233ebf31",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MonitoringSessions/6305b7a8dc4478ad233ebf31/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MonitoringSessions",
"path": [
"6t0ggef2c0deab00hb595101",
"6305b7a8dc4478ad233ebf31"
],
"summary_attrs": [
{
"name": "interval",
"title": "Interval"
},
{
"name": "start_ts",
"title": "Start"
},
{
"name": "end_ts",
"title": "End"
},
{
"name": "interface",
"title": "Interface"
},
{
"name": "MaxSessions",
"title": "Max Sessions"
},
{
"name": "MaxUtil",
"title": "Utilization %"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"interval": "day",
"pkid": "6305b7a8dc4478ad233ebf32",
"MaxUtil": 3.5,
"end_ts": "2022-08-24T00:00:00.000000Z",
"start_ts": "2022-08-23T00:00:00.000000Z",
"interface": "administration",
"MaxSessions": 7
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/MonitoringSessions. | GET | /api/data/MonitoringSessions/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/MonitoringSessions as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/MonitoringSessions/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/MonitoringSessions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/MonitoringSessions/[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/MonitoringSessions and the JSON format can be used to import instances of data/MonitoringSessions.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/MonitoringSessions/[pkid]/ | hierarchy=[hierarchy] | The data/MonitoringSessions instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/MonitoringSessions/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/MonitoringSessions. |