[Index]
AssuranceArbitratorCiscoUcceCuicGeneral resource. The schema will be used to create data/ReporterResource instances, the description is used to store the table name of the associate field.
Model ref.: data/AssuranceArbitratorCiscoUcceCuicGeneral
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": {
"lxt_timestamp_epoch": {
"title": "Lxt Timestamp Epoch",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "any"
},
"AssetName": {
"title": "Asset Name",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"ClusterFirstNodeName": {
"title": "Cluster First Node Name",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"ClusterName": {
"title": "Cluster Name",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"ClusterServerCount": {
"title": "Cluster Server Count",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"DataSourceCount": {
"title": "Data Source Count",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"DbInfoReplicationStatus": {
"title": "Db Info Replication Status",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"DbInfoSpaceUsed": {
"title": "Db Info Space Used",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"DbInfoStatus": {
"title": "Db Info Status",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"DbInfoTmpSpaceUsed": {
"title": "Db Info Tmp Space Used",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"Description": {
"title": "Description",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"EnableNotifications": {
"title": "Enable Notifications",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"EngineStatus": {
"title": "Engine Status",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"GroupsConfigured": {
"title": "Groups Configured",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"HistoricalReportDefinitionCount": {
"title": "Historical Report Definition Count",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"HistoricalReportRunning": {
"title": "Historical Report Running",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"HistoricalReportWaiting": {
"title": "Historical Report Waiting",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"Hostname": {
"title": "Hostname",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"Host": {
"title": "Host",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"IpAddress": {
"title": "Ip Address",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"JvmMemoryFree": {
"title": "Jvm Memory Free",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"JvmMemoryMax": {
"title": "Jvm Memory Max",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"JvmMemoryTotal": {
"title": "Jvm Memory Total",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"JvmPercentCPUTime": {
"title": "Jvm Percent CPU Time",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"LoginFailedAttempts": {
"title": "Login Failed Attempts",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"OpsConsoleURL": {
"title": "Ops Console URL",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"QueuedTasks": {
"title": "Queued Tasks",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"QueuedTasksMax": {
"title": "Queued Tasks Max",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"RealTimeReportDefinitionCount": {
"title": "Real Time Report Definition Count",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"RealTimeReportRunning": {
"title": "Real Time Report Running",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"RealTimeReportWaiting": {
"title": "Real Time Report Waiting",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"ServerDescription": {
"title": "Server Description",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"ServerName": {
"title": "Server Name",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"StartTime": {
"title": "Start Time",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"SystemStatus": {
"title": "System Status",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"ThreadsMaxAvailable": {
"title": "Threads Max Available",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"ThreadsRunning": {
"title": "Threads Running",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"TimeZoneName": {
"title": "Time Zone Name",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"TotalKickedOffHistoricalReports": {
"title": "Total Kicked Off Historical Reports",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"TotalKickedOffRealTimeReports": {
"title": "Total Kicked Off Real Time Reports",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"Type": {
"title": "Type",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
},
"UsersConfigured": {
"title": "Users Configured",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"UsersLoggedIn": {
"title": "Users Logged In",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "number"
},
"Version": {
"title": "Version",
"description": "CISCO_UCCE_CUIC_GENERAL",
"type": "string",
"maxLength": 1024
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/[pkid1]", "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/ |
|
The data/AssuranceArbitratorCiscoUcceCuicGeneral schema and all instances as JSON. |
(The list will return 0 to 3 data/AssuranceArbitratorCiscoUcceCuicGeneral instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "AssetName",
"direction": "asc",
"current": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/?skip=0&limit=3&order_by=AssetName&direction=asc&traversal=fulltree"
},
"operations": [
"add",
"bulk_update_form",
"list",
"update",
"transform",
"migration",
"remove",
"move",
"export",
"help",
"configuration_template",
"field_display_policy",
"get",
"export_bulkload_template"
],
"meta": {
"model_type": "data/AssuranceArbitratorCiscoUcceCuicGeneral",
"summary_attrs": [
{
"name": "AssetName",
"title": "Asset Name"
},
{
"name": "ClusterFirstNodeName",
"title": "Cluster First Node Name"
},
{
"name": "ClusterName",
"title": "Cluster Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "Host",
"title": "Host"
},
{
"name": "Hostname",
"title": "Hostname"
},
{
"name": "IpAddress",
"title": "Ip Address"
},
{
"name": "OpsConsoleURL",
"title": "Ops Console URL"
},
{
"name": "ServerDescription",
"title": "Server Description"
},
{
"name": "ServerName",
"title": "Server Name"
},
{
"name": "SystemStatus",
"title": "System Status"
},
{
"name": "TimeZoneName",
"title": "Time Zone Name"
},
{
"name": "Type",
"title": "Type"
},
{
"name": "Version",
"title": "Version"
},
{
"name": "UsersConfigured",
"title": "Users Configured"
},
{
"name": "UsersLoggedIn",
"title": "Users Logged In"
},
{
"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": [
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove"
],
"schema_version": "0.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/AssuranceArbitratorCiscoUcceCuicGeneral/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/AssuranceArbitratorCiscoUcceCuicGeneral. | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/AssuranceArbitratorCiscoUcceCuicGeneral as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/transform/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/[pkid] | hierarchy=[hierarchy] | The data/AssuranceArbitratorCiscoUcceCuicGeneral instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/AssuranceArbitratorCiscoUcceCuicGeneral/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/AssuranceArbitratorCiscoUcceCuicGeneral. |