[Index]
Model ref.: device/uccx/AgentStats
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": {
"id": {
"readonly": true,
"title": "Skill ID",
"type": "string"
},
"loggedIn": {
"description": "Number of logged in Agents.",
"readonly": true,
"title": "Logged In",
"type": "string"
},
"ready": {
"description": "Number of Agents that are ready.",
"readonly": true,
"title": "Ready",
"type": "string"
},
"notReady": {
"description": "Number of Agents that are not ready.",
"readonly": true,
"title": "Not Ready",
"type": "string"
},
"talking": {
"description": "Number of Agents that are talking.",
"readonly": true,
"title": "Talking",
"type": "string"
}
},
"schema_version": "11.6.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/uccx/AgentStats; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/uccx/AgentStats/export/ |
|
{ "hrefs":["/api/device/uccx/AgentStats/[pkid1]", "/api/device/uccx/AgentStats/[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/uccx/AgentStats and the JSON format can be used to import instances of device/uccx/AgentStats.
GET http://[host-proxy]/api/device/uccx/AgentStats/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/uccx/AgentStats/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/uccx/AgentStats/ |
|
The device/uccx/AgentStats schema and all instances as JSON. |
(The list will return 0 to 3 device/uccx/AgentStats instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "loggedIn",
"direction": "asc",
"current": "/api/device/uccx/AgentStats/?skip=0&limit=3&order_by=loggedIn&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/uccx/AgentStats",
"summary_attrs": [
{
"name": "loggedIn",
"title": "Logged In"
},
{
"name": "ready",
"title": "Ready"
},
{
"name": "notReady",
"title": "Not Ready"
},
{
"name": "talking",
"title": "Talking"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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": [
"list",
"get",
"export",
"help",
"field_display_policy"
],
"schema_version": "11.6.1",
"actions": [
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/uccx/AgentStats/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/uccx/AgentStats/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/uccx/AgentStats/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/uccx/AgentStats/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/uccx/AgentStats/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"id": "1",
"loggedIn": "0",
"ready": "0",
"notReady": "0",
"talking": "0",
"hierarchy": "5ae89ea2affa931cce38a523",
"summary_device": "Connection parameters for 10.120.11.145. UCCX auto test suite, 10.120.11.145, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/uccx/AgentStats",
"summary_attrs": [
{
"name": "loggedIn",
"title": "Logged In"
},
{
"name": "ready",
"title": "Ready"
},
{
"name": "notReady",
"title": "Not Ready"
},
{
"name": "talking",
"title": "Talking"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "0",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"device": [
{
"href": "/api/v0/data/Uccx/667883c6770d07b8daf08bf3",
"pkid": "667883c6770d07b8daf08bf3"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/",
"pkid": "66788944770d07b8daf0ead7"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"66788944770d07b8daf0ead7"
],
"schema_version": "",
"actions": [
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "66788944770d07b8daf0ead7"
}
]
}
(Show the first instance)
{
"data": {
"id": "1",
"loggedIn": "0",
"ready": "0",
"notReady": "0",
"talking": "0",
"hierarchy": "5ae89ea2affa931cce38a523"
},
"meta": {
"model_type": "device/uccx/AgentStats",
"summary_attrs": [
{
"name": "loggedIn",
"title": "Logged In"
},
{
"name": "ready",
"title": "Ready"
},
{
"name": "notReady",
"title": "Not Ready"
},
{
"name": "talking",
"title": "Talking"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "0",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"device": [
{
"href": "/api/v0/data/Uccx/667883c6770d07b8daf08bf3",
"pkid": "667883c6770d07b8daf08bf3"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/",
"pkid": "66788944770d07b8daf0ead7"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"66788944770d07b8daf0ead7"
],
"schema_version": "",
"actions": [
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/uccx/AgentStats/66788944770d07b8daf0ead7/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "66788944770d07b8daf0ead7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/uccx/AgentStats. | GET | /api/device/uccx/AgentStats/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/uccx/AgentStats as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/uccx/AgentStats/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/uccx/AgentStats; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/uccx/AgentStats/[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/uccx/AgentStats and the JSON format can be used to import instances of device/uccx/AgentStats.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/uccx/AgentStats/[pkid] | hierarchy=[hierarchy] | The device/uccx/AgentStats instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/uccx/AgentStats/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/uccx/AgentStats. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/uccx/AgentStats/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |