[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": {
"status": {
"readonly": false,
"type": "string",
"description": "Running status.",
"title": "Status"
},
"hcmf_models": {
"items": {
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "Instance count of the model type.",
"title": "Count"
},
"modeltype": {
"type": "string",
"description": "Model Type.",
"title": "Model Type"
}
}
},
"readonly": false,
"type": "array",
"description": "HCMF Model instance count.",
"title": "HCMF Models"
},
"data_models": {
"items": {
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "Instance count of the model type.",
"title": "Count"
},
"modeltype": {
"type": "string",
"description": "Model Type.",
"title": "Model Type"
}
}
},
"readonly": false,
"type": "array",
"description": "DATA Model instance count.",
"title": "DATA Models"
},
"title": {
"readonly": false,
"type": "string",
"description": "Title of the report.",
"title": "Report Title"
},
"timestamp": {
"readonly": false,
"required": true,
"type": "string",
"title": "Time Stamp"
},
"ldap_models": {
"items": {
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "Instance count of the model type.",
"title": "Count"
},
"modeltype": {
"type": "string",
"description": "Model Type.",
"title": "Model Type"
}
}
},
"readonly": false,
"type": "array",
"description": "LDAP Model instance count.",
"title": "LDAP Models"
},
"cuc_models": {
"items": {
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "Instance count of the model type.",
"title": "Count"
},
"modeltype": {
"type": "string",
"description": "Model Type.",
"title": "Model Type"
}
}
},
"readonly": false,
"type": "array",
"description": "CUC Model instance count.",
"title": "CUC Models"
},
"cucm_models": {
"items": {
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "Instance count of the model type.",
"title": "Count"
},
"modeltype": {
"type": "string",
"description": "Model Type.",
"title": "Model Type"
}
}
},
"readonly": false,
"type": "array",
"description": "CUCM Model instance count.",
"title": "CUCM Models"
},
"id": {
"readonly": false,
"required": true,
"type": "string",
"description": "Unique ID of the report.",
"title": "ID"
}
},
"schema_version": "0.1"
}
| 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)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "id",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/ModelReport/?skip=0&limit=3&order_by=id&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "0.1",
"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/ModelReport/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/ModelReport/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/ModelReport/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/ModelReport",
"model_specific_actions": [
"get",
"help",
"list",
"remove"
],
"summary_attrs": [
{
"name": "id",
"title": "ID"
},
{
"name": "status",
"title": "Status"
},
{
"name": "timestamp",
"title": "Time Stamp"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| 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. |