[Index]
LINE REPORT Information about one CUCM line, including whether its referenced by devices in another site (Used Across Sites), whether its shared within the site, the hierarchy of the corresponding DN inventory for the pattern if it exists, and the full list of devices which reference the line, including who owns the device (in the case of phones) and in which hierarchy the device resides. These models can be generated from the Administration > Reports > Create Line Report view. To avoid having too many instances of this model accumulate, delete the instances when finished with them. This can be done individually, or by clicking the checkbox in the heading of the list view to select all instances in the list and click Delete.
Model ref.: data/HcsLineReportDAT
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": {
"device_profiles": {
"is_password": false,
"description": "The list of device profiles within the customer which reference the line.",
"title": "Device Profiles",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"hierarchy": {
"is_password": false,
"description": "Hierarchy where the device profile exists which references the line.",
"title": "Hierarchy",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"end_user": {
"is_password": false,
"description": "The user ID of the CUCM end user that owns this device profile.",
"title": "End User",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"device_name": {
"is_password": false,
"description": "Device name of the device profile which references the line.",
"title": "Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"pattern": {
"is_password": false,
"description": "Directory number of the line.",
"title": "Pattern",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"partition": {
"is_password": false,
"description": "The route partition of the line. The pattern combined with the partition defines the uniqueness of the line in CUCM.",
"title": "Partition",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"device_count": {
"is_password": false,
"description": "Number of devices across all sites that are using this line.",
"title": "Device Count",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"dn_inventory_hn": {
"is_password": false,
"description": "Hierarchy where the DN inventory for the pattern is defined. If empty, no DN inventory exists for this pattern.",
"title": "DN Inventory Hierarchy",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"shared_within_site": {
"is_password": false,
"description": "Indicates whether this line is shared between multiple phones within the site where the line exists.",
"title": "Shared Within Site",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"timestamp": {
"is_password": false,
"description": "Time when the report was generated.",
"title": "Timestamp",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"phones": {
"is_password": false,
"description": "The list of phones within the customer which reference the line.",
"title": "Phones",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"hierarchy": {
"is_password": false,
"description": "Hierarchy where the phone exists which references the line.",
"title": "Hierarchy",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"end_user": {
"is_password": false,
"description": "The user ID of the CUCM end user that owns this phone.",
"title": "End User",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"device_name": {
"is_password": false,
"description": "Device name of the phone which references the line.",
"title": "Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"line_hn": {
"is_password": false,
"description": "Hierarchy where the CUCM line with this pattern and partition is defined.",
"title": "Line Hierarchy",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"used_across_sites": {
"is_password": false,
"description": "Indicates whether this line is referenced by at least one phone which exists in a different site.",
"title": "Used Across Sites",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"remote_destination_profiles": {
"is_password": false,
"description": "The list of remote destination profiles within the customer which reference the line.",
"title": "Remote Destination Profiles",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"hierarchy": {
"is_password": false,
"description": "Hierarchy where the remote destination profile exists which references the line.",
"title": "Hierarchy",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"end_user": {
"is_password": false,
"description": "The user ID of the CUCM end user that owns this remote destination profile.",
"title": "End User",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"device_name": {
"is_password": false,
"description": "Name of the remote destination profile which references the line.",
"title": "Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsLineReportDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsLineReportDAT/[pkid1]", "/api/data/HcsLineReportDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsLineReportDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsLineReportDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsLineReportDAT/export/ |
|
{ "hrefs":["/api/data/HcsLineReportDAT/[pkid1]", "/api/data/HcsLineReportDAT/[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/HcsLineReportDAT and the JSON format can be used to import instances of data/HcsLineReportDAT.
GET http://[host-proxy]/api/data/HcsLineReportDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsLineReportDAT/ |
|
The data/HcsLineReportDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsLineReportDAT 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": "pattern",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsLineReportDAT/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.3",
"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/HcsLineReportDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsLineReportDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsLineReportDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsLineReportDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsLineReportDAT",
"model_specific_actions": [
"remove",
"get",
"list",
"export",
"help"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "partition",
"title": "Partition"
},
{
"name": "line_hn",
"title": "Line Hierarchy"
},
{
"name": "dn_inventory_hn",
"title": "DN Inventory Hierarchy"
},
{
"name": "device_count",
"title": "Device Count"
},
{
"name": "used_across_sites",
"title": "Used Across Sites"
},
{
"name": "shared_within_site",
"title": "Shared Within Site"
},
{
"name": "timestamp",
"title": "Timestamp"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsLineReportDAT. | GET | /api/data/HcsLineReportDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsLineReportDAT as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsLineReportDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/HcsLineReportDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsLineReportDAT/[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/HcsLineReportDAT and the JSON format can be used to import instances of data/HcsLineReportDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsLineReportDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsLineReportDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsLineReportDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsLineReportDAT. |