[Index]
Data model to capture Model list and instance counts under a certain hierarchy.
Model ref.: data/ModelReport
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": {
"title": {
"title": "Report Title",
"description": "Title of the report.",
"type": "string",
"readonly": false
},
"status": {
"title": "Status",
"description": "Running status.",
"type": "string",
"readonly": false
},
"timestamp": {
"title": "Time Stamp",
"type": "string",
"required": true,
"readonly": false
},
"data_models": {
"title": "DATA Models",
"description": "DATA Model instance count.",
"type": "array",
"readonly": false,
"items": {
"type": "object",
"properties": {
"modeltype": {
"title": "Model Type",
"description": "Model Type.",
"type": "string"
},
"count": {
"title": "Count",
"description": "Instance count of the model type.",
"type": "string"
}
}
}
},
"cucm_models": {
"title": "CUCM Models",
"description": "CUCM Model instance count.",
"type": "array",
"readonly": false,
"items": {
"type": "object",
"properties": {
"modeltype": {
"title": "Model Type",
"description": "Model Type.",
"type": "string"
},
"count": {
"title": "Count",
"description": "Instance count of the model type.",
"type": "string"
}
}
}
},
"cuc_models": {
"title": "CUC Models",
"description": "CUC Model instance count.",
"type": "array",
"readonly": false,
"items": {
"type": "object",
"properties": {
"modeltype": {
"title": "Model Type",
"description": "Model Type.",
"type": "string"
},
"count": {
"title": "Count",
"description": "Instance count of the model type.",
"type": "string"
}
}
}
},
"ldap_models": {
"title": "LDAP Models",
"description": "LDAP Model instance count.",
"type": "array",
"readonly": false,
"items": {
"type": "object",
"properties": {
"modeltype": {
"title": "Model Type",
"description": "Model Type.",
"type": "string"
},
"count": {
"title": "Count",
"description": "Instance count of the model type.",
"type": "string"
}
}
}
},
"id": {
"title": "ID",
"description": "Unique ID of the report.",
"type": "string",
"required": true,
"readonly": false
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/ModelReport/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/ModelReport/[pkid1]", "/api/data/ModelReport/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/ModelReport/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/ModelReport/ |
|
The data/ModelReport schema and all instances as JSON. |
(The list will return 0 to 3 data/ModelReport instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "id",
"direction": "asc",
"current": "/api/data/ModelReport/?skip=0&limit=3&order_by=id&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/ModelReport",
"summary_attrs": [
{
"name": "id",
"title": "ID"
},
{
"name": "status",
"title": "Status"
},
{
"name": "timestamp",
"title": "Time Stamp"
},
{
"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": [
"get",
"help",
"list",
"remove"
],
"schema_version": "1.0",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelReport/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/ModelReport/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelReport/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"status": "Done",
"title": "Model instance count [sys.hcs.CS-P.CS-AB.AB_Group] for model types [CUCM]",
"pkid": "5aeb5ff0affa931cce42fc25",
"timestamp": "2018-05-03 21:16:00.110603",
"cucm_models": [
{
"count": "48",
"modeltype": "device/cucm/Announcement"
},
{
"count": "2",
"modeltype": "device/cucm/Annunciator"
},
{
"count": "22",
"modeltype": "device/cucm/AppUser"
},
{
"count": "4",
"modeltype": "device/cucm/AudioCodecPreferenceList"
},
{
"count": "2",
"modeltype": "device/cucm/CallManager"
},
{
"count": "10",
"modeltype": "device/cucm/CallManagerGroup"
},
{
"count": "24",
"modeltype": "device/cucm/CallingPartyTransformationPattern"
},
{
"count": "2",
"modeltype": "device/cucm/CommonPhoneConfig"
},
{
"count": "2",
"modeltype": "device/cucm/ConferenceBridge"
},
{
"count": "168",
"modeltype": "device/cucm/Country"
},
{
"count": "2",
"modeltype": "device/cucm/CredentialPolicy"
},
{
"count": "6",
"modeltype": "device/cucm/CredentialPolicyDefault"
},
{
"count": "151",
"modeltype": "device/cucm/Css"
},
{
"count": "14",
"modeltype": "device/cucm/DateTimeGroup"
},
{
"count": "62",
"modeltype": "device/cucm/Ddi"
},
{
"count": "28",
"modeltype": "device/cucm/DefaultDeviceProfile"
},
{
"count": "30",
"modeltype": "device/cucm/DevicePool"
},
{
"count": "42",
"modeltype": "device/cucm/DeviceProfile"
},
{
"count": "2",
"modeltype": "device/cucm/DialPlan"
},
{
"count": "42",
"modeltype": "device/cucm/DialPlanTag"
},
{
"count": "62",
"modeltype": "device/cucm/DiscardDigitInstruction"
},
{
"count": "2",
"modeltype": "device/cucm/EnterpriseFeatureAccessConfiguration"
},
{
"count": "2",
"modeltype": "device/cucm/FeatureGroupTemplate"
},
{
"count": "16",
"modeltype": "device/cucm/GatewayEndpointType"
},
{
"count": "104",
"modeltype": "device/cucm/GatewayType"
},
{
"count": "2",
"modeltype": "device/cucm/GeoLocation"
},
{
"count": "16",
"modeltype": "device/cucm/IpPhoneServices"
},
{
"count": "2",
"modeltype": "device/cucm/LdapSystem"
},
{
"count": "28",
"modeltype": "device/cucm/Line"
},
{
"count": "24",
"modeltype": "device/cucm/LocalRouteGroup"
},
{
"count": "34",
"modeltype": "device/cucm/Location"
},
{
"count": "2",
"modeltype": "device/cucm/MlppDomain"
},
{
"count": "2",
"modeltype": "device/cucm/MobileSmartClientProfile"
},
{
"count": "2",
"modeltype": "device/cucm/MohAudioSource"
},
{
"count": "2",
"modeltype": "device/cucm/MohServer"
},
{
"count": "2",
"modeltype": "device/cucm/Mtp"
},
{
"count": "65",
"modeltype": "device/cucm/Phone"
},
{
"count": "348",
"modeltype": "device/cucm/PhoneButtonTemplate"
},
{
"count": "348",
"modeltype": "device/cucm/PhoneSecurityProfile"
},
{
"count": "278",
"modeltype": "device/cucm/PhoneType"
},
{
"count": "2",
"modeltype": "device/cucm/PresenceGroup"
},
{
"count": "4",
"modeltype": "device/cucm/ProcessNode"
},
{
"count": "150",
"modeltype": "device/cucm/ProcessNodeService"
},
{
"count": "30",
"modeltype": "device/cucm/Region"
},
{
"count": "21",
"modeltype": "device/cucm/RemoteDestination"
},
{
"count": "2",
"modeltype": "device/cucm/RemoteDestinationProfile"
},
{
"count": "2",
"modeltype": "device/cucm/RouteGroup"
},
{
"count": "90",
"modeltype": "device/cucm/RouteList"
},
{
"count": "205",
"modeltype": "device/cucm/RoutePartition"
},
{
"count": "380",
"modeltype": "device/cucm/RoutePattern"
},
{
"count": "2",
"modeltype": "device/cucm/RoutePlan"
},
{
"count": "16",
"modeltype": "device/cucm/SIPNormalizationScript"
},
{
"count": "2",
"modeltype": "device/cucm/SdpTransparencyProfile"
},
{
"count": "1914",
"modeltype": "device/cucm/ServiceParameter"
},
{
"count": "12",
"modeltype": "device/cucm/SipProfile"
},
{
"count": "2",
"modeltype": "device/cucm/SipTrunk"
},
{
"count": "6",
"modeltype": "device/cucm/SipTrunkSecurityProfile"
},
{
"count": "16",
"modeltype": "device/cucm/SoftKeyTemplate"
},
{
"count": "4",
"modeltype": "device/cucm/Srst"
},
{
"count": "10",
"modeltype": "device/cucm/TimePeriod"
},
{
"count": "8",
"modeltype": "device/cucm/TimeSchedule"
},
{
"count": "21",
"modeltype": "device/cucm/TodAccess"
},
{
"count": "987",
"modeltype": "device/cucm/TransPattern"
},
{
"count": "32",
"modeltype": "device/cucm/TvsCertificate"
},
{
"count": "4",
"modeltype": "device/cucm/UniversalDeviceTemplate"
},
{
"count": "2",
"modeltype": "device/cucm/UniversalLineTemplate"
},
{
"count": "46",
"modeltype": "device/cucm/User"
},
{
"count": "56",
"modeltype": "device/cucm/UserGroup"
},
{
"count": "4",
"modeltype": "device/cucm/UserLocale"
},
{
"count": "2",
"modeltype": "device/cucm/UserProfileProvision"
},
{
"count": "2",
"modeltype": "device/cucm/VoiceMailPilot"
},
{
"count": "6",
"modeltype": "device/cucm/VoiceMailProfile"
}
],
"id": "1",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/ModelReport",
"summary_attrs": [
{
"name": "id",
"title": "ID"
},
{
"name": "status",
"title": "Status"
},
{
"name": "timestamp",
"title": "Time Stamp"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "Model instance count [sys.hcs.CS-P.CS-AB.AB_Group] for model types [CUCM]",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/",
"pkid": "5aeb5ff0affa931cce42fc24"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5aeb5ff0affa931cce42fc24"
],
"schema_version": "1.0",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/",
"support_async": true,
"title": "Delete"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5aeb5ff0affa931cce42fc24"
}
]
}
(Show the first instance)
{
"data": {
"status": "Done",
"title": "Model instance count [sys.hcs.CS-P.CS-AB.AB_Group] for model types [CUCM]",
"timestamp": "2018-05-03 21:16:00.110603",
"cucm_models": [
{
"count": "48",
"modeltype": "device/cucm/Announcement"
},
{
"count": "2",
"modeltype": "device/cucm/Annunciator"
},
{
"count": "22",
"modeltype": "device/cucm/AppUser"
},
{
"count": "4",
"modeltype": "device/cucm/AudioCodecPreferenceList"
},
{
"count": "2",
"modeltype": "device/cucm/CallManager"
},
{
"count": "10",
"modeltype": "device/cucm/CallManagerGroup"
},
{
"count": "24",
"modeltype": "device/cucm/CallingPartyTransformationPattern"
},
{
"count": "2",
"modeltype": "device/cucm/CommonPhoneConfig"
},
{
"count": "2",
"modeltype": "device/cucm/ConferenceBridge"
},
{
"count": "168",
"modeltype": "device/cucm/Country"
},
{
"count": "2",
"modeltype": "device/cucm/CredentialPolicy"
},
{
"count": "6",
"modeltype": "device/cucm/CredentialPolicyDefault"
},
{
"count": "151",
"modeltype": "device/cucm/Css"
},
{
"count": "14",
"modeltype": "device/cucm/DateTimeGroup"
},
{
"count": "62",
"modeltype": "device/cucm/Ddi"
},
{
"count": "28",
"modeltype": "device/cucm/DefaultDeviceProfile"
},
{
"count": "30",
"modeltype": "device/cucm/DevicePool"
},
{
"count": "42",
"modeltype": "device/cucm/DeviceProfile"
},
{
"count": "2",
"modeltype": "device/cucm/DialPlan"
},
{
"count": "42",
"modeltype": "device/cucm/DialPlanTag"
},
{
"count": "62",
"modeltype": "device/cucm/DiscardDigitInstruction"
},
{
"count": "2",
"modeltype": "device/cucm/EnterpriseFeatureAccessConfiguration"
},
{
"count": "2",
"modeltype": "device/cucm/FeatureGroupTemplate"
},
{
"count": "16",
"modeltype": "device/cucm/GatewayEndpointType"
},
{
"count": "104",
"modeltype": "device/cucm/GatewayType"
},
{
"count": "2",
"modeltype": "device/cucm/GeoLocation"
},
{
"count": "16",
"modeltype": "device/cucm/IpPhoneServices"
},
{
"count": "2",
"modeltype": "device/cucm/LdapSystem"
},
{
"count": "28",
"modeltype": "device/cucm/Line"
},
{
"count": "24",
"modeltype": "device/cucm/LocalRouteGroup"
},
{
"count": "34",
"modeltype": "device/cucm/Location"
},
{
"count": "2",
"modeltype": "device/cucm/MlppDomain"
},
{
"count": "2",
"modeltype": "device/cucm/MobileSmartClientProfile"
},
{
"count": "2",
"modeltype": "device/cucm/MohAudioSource"
},
{
"count": "2",
"modeltype": "device/cucm/MohServer"
},
{
"count": "2",
"modeltype": "device/cucm/Mtp"
},
{
"count": "65",
"modeltype": "device/cucm/Phone"
},
{
"count": "348",
"modeltype": "device/cucm/PhoneButtonTemplate"
},
{
"count": "348",
"modeltype": "device/cucm/PhoneSecurityProfile"
},
{
"count": "278",
"modeltype": "device/cucm/PhoneType"
},
{
"count": "2",
"modeltype": "device/cucm/PresenceGroup"
},
{
"count": "4",
"modeltype": "device/cucm/ProcessNode"
},
{
"count": "150",
"modeltype": "device/cucm/ProcessNodeService"
},
{
"count": "30",
"modeltype": "device/cucm/Region"
},
{
"count": "21",
"modeltype": "device/cucm/RemoteDestination"
},
{
"count": "2",
"modeltype": "device/cucm/RemoteDestinationProfile"
},
{
"count": "2",
"modeltype": "device/cucm/RouteGroup"
},
{
"count": "90",
"modeltype": "device/cucm/RouteList"
},
{
"count": "205",
"modeltype": "device/cucm/RoutePartition"
},
{
"count": "380",
"modeltype": "device/cucm/RoutePattern"
},
{
"count": "2",
"modeltype": "device/cucm/RoutePlan"
},
{
"count": "16",
"modeltype": "device/cucm/SIPNormalizationScript"
},
{
"count": "2",
"modeltype": "device/cucm/SdpTransparencyProfile"
},
{
"count": "1914",
"modeltype": "device/cucm/ServiceParameter"
},
{
"count": "12",
"modeltype": "device/cucm/SipProfile"
},
{
"count": "2",
"modeltype": "device/cucm/SipTrunk"
},
{
"count": "6",
"modeltype": "device/cucm/SipTrunkSecurityProfile"
},
{
"count": "16",
"modeltype": "device/cucm/SoftKeyTemplate"
},
{
"count": "4",
"modeltype": "device/cucm/Srst"
},
{
"count": "10",
"modeltype": "device/cucm/TimePeriod"
},
{
"count": "8",
"modeltype": "device/cucm/TimeSchedule"
},
{
"count": "21",
"modeltype": "device/cucm/TodAccess"
},
{
"count": "987",
"modeltype": "device/cucm/TransPattern"
},
{
"count": "32",
"modeltype": "device/cucm/TvsCertificate"
},
{
"count": "4",
"modeltype": "device/cucm/UniversalDeviceTemplate"
},
{
"count": "2",
"modeltype": "device/cucm/UniversalLineTemplate"
},
{
"count": "46",
"modeltype": "device/cucm/User"
},
{
"count": "56",
"modeltype": "device/cucm/UserGroup"
},
{
"count": "4",
"modeltype": "device/cucm/UserLocale"
},
{
"count": "2",
"modeltype": "device/cucm/UserProfileProvision"
},
{
"count": "2",
"modeltype": "device/cucm/VoiceMailPilot"
},
{
"count": "6",
"modeltype": "device/cucm/VoiceMailProfile"
}
],
"id": "1",
"pkid": "5aeb5ff0affa931cce42fc25"
},
"meta": {
"model_type": "data/ModelReport",
"summary_attrs": [
{
"name": "id",
"title": "ID"
},
{
"name": "status",
"title": "Status"
},
{
"name": "timestamp",
"title": "Time Stamp"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "Model instance count [sys.hcs.CS-P.CS-AB.AB_Group] for model types [CUCM]",
"business_key": {},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/",
"pkid": "5aeb5ff0affa931cce42fc24"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5aeb5ff0affa931cce42fc24"
],
"schema_version": "1.0",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelReport/5aeb5ff0affa931cce42fc24/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5aeb5ff0affa931cce42fc24"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/ModelReport. | GET | /api/data/ModelReport/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/ModelReport as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/ModelReport/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/ModelReport/[pkid] | hierarchy=[hierarchy] | The data/ModelReport instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/ModelReport/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/ModelReport. |