[Index]
Model ref.: device/cucm/LineGroup
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": {
"huntAlgorithmNoAnswer": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer. This option gets applied at the member level. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group when the RNA reversion timeout value elapses for the first member. Cisco Unified Communications Manager then proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first member of this line group and the member does not answer the call. \n ",
"title": "No Answer",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"name": {
"description": " Enter a name for this line group. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each line group name is unique to the route plan. \n \n \n \n Timesaver\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your line groups. The CompanynameLocationGroup format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a line group. For example, CiscoDallasAA1 identifies a Cisco Access Analog line group for the Cisco office in Dallas. \n \n \n ",
"title": "Line Group Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"distributionAlgorithm": {
"description": " Choose a distribution algorithm, which applies at the line-group level, from the options in the drop-down list box: \n \n \n \n Top Down\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. \n \n Circular\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the (n+1)th member of a route group, where the nth member is the next sequential member in the list who is either idle or busy but not \"down.\" If the nth member is the last member of a route group, Cisco Unified Communications Manager distributes a call starting from the top of the route group. \n \n Longest Idle Time\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager only distributes a call to idle members, starting from the longest idle member to the least idle member of a line group. \n \n Broadcast\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to all idle or available members of a line group simultaneously. See the Note in the description of the Selected DN/Route Partition field for additional limitations in using the Broadcast distribution algorithm. \n The default value specifies Longest Idle Time. ",
"title": "Distribution Algorithm",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Top Down",
"title": "Top Down"
},
{
"value": "Circular",
"title": "Circular"
},
{
"value": "Longest Idle Time",
"title": "Longest Idle Time"
},
{
"value": "Broadcast",
"title": "Broadcast"
}
],
"default": "Longest Idle Time",
"maxItems": 1,
"type": "string"
},
"huntAlgorithmNotAvailable": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering the first unavailable member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first unavailable member of this line group. \n ",
"title": "Not Available",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"members": {
"title": "Members",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"directoryNumber": {
"description": "The uuid attribute is read here",
"title": "Directory Number",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pattern": {
"description": " Enter the character(s) that are found in the directory number that you are seeking and click the Find button. Directory numbers that match the character(s) that you entered display in the Available DN/Route Partition box. ",
"name": "pattern",
"format": "uri",
"minItems": 1,
"title": "Directory Number Contains",
"required": true,
"choices": [],
"target_attr": "pattern",
"maxItems": 1,
"target_model_type": "device/cucm/Line",
"type": "string",
"target": "/api/device/cucm/Line/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"routePartitionName": {
"description": " Choose a route partition for this line group from the drop-down list box. The default value specifies <None>. If you click Find, the Available DN/Route Partition list box displays all DNs that belong to the chosen partition. ",
"name": "routePartitionName",
"format": "uri",
"minItems": 1,
"title": "Partition",
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"name": "directoryNumber"
},
"lineSelectionOrder": {
"name": "lineSelectionOrder",
"title": "Line Selection Order",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
}
}
},
"required": false,
"type": "array"
}
}
},
"rnaReversionTimeOut": {
"description": " Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, Try next member; then, try next group in Hunt List, is chosen. The RNA Reversion Timeout applies at the line-group level to all members. ",
"title": "RNA Reversion Timeout",
"minItems": 1,
"required": true,
"default": 10,
"maxItems": 1,
"type": "integer"
},
"huntAlgorithmBusy": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering a busy member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first busy member of this line group. \n ",
"title": "Busy",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"autoLogOffHunt": {
"description": "If this check box is checked, line members will be logged off the hunt list automatically. Line members can log back in using the \"HLOG\" softkey or PLK. ",
"title": "Automatically Logout Hunt Member on No Answer",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/LineGroup/add/ |
|
The GUI Add form of device/cucm/LineGroup as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cucm/LineGroup/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/LineGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/LineGroup/[pkid1]", "/api/device/cucm/LineGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/LineGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/LineGroup/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/LineGroup/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/LineGroup/[pkid1]", "/api/v0/device/cucm/LineGroup/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/LineGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/LineGroup |
|
{"hrefs": ["/api/device/cucm/LineGroup/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/LineGroup |
|
{"hrefs": ["/api/device/cucm/LineGroup/[pkid1]", "/api/device/cucm/LineGroup/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/LineGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/LineGroup/export/ |
|
{ "hrefs":["/api/device/cucm/LineGroup/[pkid1]", "/api/device/cucm/LineGroup/[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/cucm/LineGroup and the JSON format can be used to import instances of device/cucm/LineGroup.
GET http://[host-proxy]/api/device/cucm/LineGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/LineGroup | POST | /api/device/cucm/LineGroup/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cucm/LineGroup/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/LineGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/LineGroup/ |
|
The device/cucm/LineGroup schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/LineGroup instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"add",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/LineGroup/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cucm/LineGroup/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/LineGroup/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/LineGroup/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/LineGroup",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/LineGroup/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cucm/LineGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/LineGroup/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/LineGroup/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/LineGroup/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/LineGroup/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/LineGroup/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/LineGroup",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Line Group Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6109e447e04a4a0014a291ee",
"meta": {
"tags": [],
"cached": true,
"title": "CUCDM8-NG",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109e3bae04a4a0014a283a1",
"href": "/api/v0/data/CallManager/6109e3bae04a4a0014a283a1"
}
],
"self": [
{
"pkid": "6109e447e04a4a0014a291ee",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/"
}
],
"parent": [
{
"pkid": "6109e3a5e04a4a0014a27e3a",
"href": "/api/data/HierarchyNode/6109e3a5e04a4a0014a27e3a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109e447e04a4a0014a291ee/?model_type=device/cucm/LineGroup",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/LineGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109e3a5e04a4a0014a27e3a",
"6109e447e04a4a0014a291ee"
],
"summary_attrs": [
{
"name": "name",
"title": "Line Group Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"huntAlgorithmNoAnswer": "Try next member; then, try next group in Hunt List",
"name": "CUCDM8-NG",
"hierarchy": "6109e3a5e04a4a0014a27e3a",
"distributionAlgorithm": "Longest Idle Time",
"huntAlgorithmNotAvailable": "Try next member; then, try next group in Hunt List",
"members": null,
"rnaReversionTimeOut": 10,
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"huntAlgorithmBusy": "Try next member; then, try next group in Hunt List",
"autoLogOffHunt": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "6109e446e04a4a0014a291eb",
"meta": {
"tags": [],
"cached": true,
"title": "NewDialPlanOverbuildSiteNG",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "6109e3bae04a4a0014a283a1",
"href": "/api/v0/data/CallManager/6109e3bae04a4a0014a283a1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109e446e04a4a0014a291eb",
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/"
}
],
"parent": [
{
"pkid": "6109e3a5e04a4a0014a27e3a",
"href": "/api/data/HierarchyNode/6109e3a5e04a4a0014a27e3a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109e446e04a4a0014a291eb/?model_type=device/cucm/LineGroup",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/LineGroup/6109e446e04a4a0014a291eb/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/LineGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109e3a5e04a4a0014a27e3a",
"6109e446e04a4a0014a291eb"
],
"summary_attrs": [
{
"name": "name",
"title": "Line Group Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"huntAlgorithmNoAnswer": "Try next member; then, try next group in Hunt List",
"name": "NewDialPlanOverbuildSiteNG",
"distributionAlgorithm": "Longest Idle Time",
"huntAlgorithmNotAvailable": "Try next member; then, try next group in Hunt List",
"members": {
"member": [
{
"directoryNumber": {
"pattern": "81005100",
"routePartitionName": "Site19"
},
"lineSelectionOrder": 0
}
]
},
"rnaReversionTimeOut": 10,
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"huntAlgorithmBusy": "Try next member; then, try next group in Hunt List",
"autoLogOffHunt": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "610a2ea6e04a4a0014aa5c26",
"meta": {
"tags": [],
"cached": true,
"title": "NewLG",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "6109c094e04a4a00149d75a4",
"href": "/api/v0/data/CallManager/6109c094e04a4a00149d75a4"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610a2ea6e04a4a0014aa5c26",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/"
}
],
"parent": [
{
"pkid": "6109c228e04a4a00149dd97c",
"href": "/api/data/HierarchyNode/6109c228e04a4a00149dd97c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/610a2ea6e04a4a0014aa5c26/?model_type=device/cucm/LineGroup",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/LineGroup/610a2ea6e04a4a0014aa5c26/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/LineGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c228e04a4a00149dd97c",
"610a2ea6e04a4a0014aa5c26"
],
"summary_attrs": [
{
"name": "name",
"title": "Line Group Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"huntAlgorithmNoAnswer": "Try next member; then, try next group in Hunt List",
"name": "NewLG",
"distributionAlgorithm": "Longest Idle Time",
"huntAlgorithmNotAvailable": "Try next member; then, try next group in Hunt List",
"members": null,
"rnaReversionTimeOut": 10,
"hierarchy_friendly_name": "LOC001 (Site)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"huntAlgorithmBusy": "Try next member; then, try next group in Hunt List",
"autoLogOffHunt": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001"
}
}
]
}
(Show the first instance)
{
"pkid": "6109e447e04a4a0014a291ee",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "CUCDM8-NG",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "6109e3a5e04a4a0014a27e3a",
"href": "/api/data/HierarchyNode/6109e3a5e04a4a0014a27e3a"
}
],
"self": [
{
"pkid": "6109e447e04a4a0014a291ee",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109e3bae04a4a0014a283a1",
"href": "/api/v0/data/CallManager/6109e3bae04a4a0014a283a1"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109e447e04a4a0014a291ee/?hierarchy=[hierarchy]&model_type=device/cucm/LineGroup",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/LineGroup/6109e447e04a4a0014a291ee/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/LineGroup",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109e3a5e04a4a0014a27e3a",
"6109e447e04a4a0014a291ee"
],
"summary_attrs": [
{
"name": "name",
"title": "Line Group Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"huntAlgorithmNoAnswer": "Try next member; then, try next group in Hunt List",
"name": "CUCDM8-NG",
"distributionAlgorithm": "Longest Idle Time",
"huntAlgorithmNotAvailable": "Try next member; then, try next group in Hunt List",
"members": null,
"rnaReversionTimeOut": 10,
"huntAlgorithmBusy": "Try next member; then, try next group in Hunt List",
"autoLogOffHunt": false
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/LineGroup. | GET | /api/device/cucm/LineGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/LineGroup as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/LineGroup/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/LineGroup/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/LineGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/LineGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/LineGroup | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cucm/LineGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/LineGroup/[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/cucm/LineGroup and the JSON format can be used to import instances of device/cucm/LineGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/LineGroup/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/LineGroup instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/LineGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/LineGroup. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/LineGroup/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |