[Index]
Model ref.: device/cucm/UniversalLineTemplate
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": { "name": { "title": "Name", "minItems": 1, "required": true, "maxItems": 1, "type": "string" }, "urgentPriority": { "title": "Urgent Priority", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "lineDescription": { "title": "Line Description", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "routePartition": { "title": "Route Partition", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/RoutePartition", "choices": [] }, "voiceMailProfile": { "title": "Voice Mail Profile", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/VoiceMailProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/VoiceMailProfile", "choices": [] }, "callingSearchSpace": { "title": "Calling Search Space", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "alertingName": { "title": "Alerting Name", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "extCallControlProfile": { "title": "Ext Call Control Profile", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/CallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/CallControlProfile", "choices": [] }, "blfPresenceGroup": { "title": "Blf Presence Group", "minItems": 1, "required": true, "maxItems": 1, "type": "string", "format": "uri", "target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/PresenceGroup", "choices": [] }, "callPickupGroup": { "title": "Call Pickup Group", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "partyEntranceTone": { "title": "Party Entrance Tone", "minItems": 1, "required": true, "maxItems": 1, "default": "Default", "type": "string", "choices": [ { "title": "Off", "value": "Off" }, { "title": "On", "value": "On" }, { "title": "Default", "value": "Default" } ] }, "autoAnswer": { "title": "Auto Answer", "minItems": 1, "required": true, "maxItems": 1, "default": "Auto Answer Off", "type": "string", "choices": [ { "title": "Auto Answer Off", "value": "Auto Answer Off" }, { "title": "Auto Answer with Headset", "value": "Auto Answer with Headset" }, { "title": "Auto Answer with Speakerphone", "value": "Auto Answer with Speakerphone" } ] }, "rejectAnonymousCall": { "title": "Reject Anonymous Call", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "userHoldMohAudioSource": { "title": "User Hold Moh Audio Source", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null", "integer" ], "choices": [], "format": "uri", "target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "sourceId", "target_model_type": "device/cucm/MohAudioSource" }, "networkHoldMohAudioSource": { "title": "Network Hold Moh Audio Source", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null", "integer" ], "choices": [], "format": "uri", "target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "sourceId", "target_model_type": "device/cucm/MohAudioSource" }, "aarDestinationMask": { "title": "Aar Destination Mask", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "maxLength": 128 }, "aarGroup": { "title": "Aar Group", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/AarGroup", "choices": [] }, "retainDestInCallFwdHistory": { "title": "Retain Dest In Call Fwd History", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "forwardDestAllCalls": { "title": "Forward Dest All Calls", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "primaryCssForwardingAllCalls": { "title": "Primary Css Forwarding All Calls", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "secondaryCssForwardingAllCalls": { "title": "Secondary Css Forwarding All Calls", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "CssActivationPolicy": { "title": "Css Activation Policy", "minItems": 0, "required": false, "maxItems": 1, "default": "Use System Default", "type": "string", "choices": [ { "title": "Use System Default", "value": "Use System Default" }, { "title": "With Configured CSS", "value": "With Configured CSS" }, { "title": "With Activating Device/Line CSS", "value": "With Activating Device/Line CSS" } ] }, "fwdDestExtCallsWhenNotRetrieved": { "title": "Fwd Dest Ext Calls When Not Retrieved", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "cssFwdExtCallsWhenNotRetrieved": { "title": "Css Fwd Ext Calls When Not Retrieved", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "fwdDestInternalCallsWhenNotRetrieved": { "title": "Fwd Dest Internal Calls When Not Retrieved", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "cssFwdInternalCallsWhenNotRetrieved": { "title": "Css Fwd Internal Calls When Not Retrieved", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "parkMonitorReversionTime": { "title": "Park Monitor Reversion Time", "minItems": 0, "required": false, "maxItems": 1, "type": [ "integer", "null" ] }, "target": { "title": "Target", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "mlppCss": { "title": "Mlpp Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "mlppNoAnsRingDuration": { "title": "Mlpp No Ans Ring Duration", "minItems": 0, "required": false, "maxItems": 1, "type": [ "integer", "null" ] }, "holdReversionRingDuration": { "title": "Hold Reversion Ring Duration", "minItems": 0, "required": false, "maxItems": 1, "type": [ "integer", "null" ] }, "holdReversionNotificationInterval": { "title": "Hold Reversion Notification Interval", "minItems": 0, "required": false, "maxItems": 1, "type": [ "integer", "null" ] }, "busyIntCallsDestination": { "title": "Busy Int Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "busyIntCallsCss": { "title": "Busy Int Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "busyExtCallsDestination": { "title": "Busy Ext Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "busyExtCallsCss": { "title": "Busy Ext Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "noAnsIntCallsDestination": { "title": "No Ans Int Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "noAnsIntCallsCss": { "title": "No Ans Int Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "noAnsExtCallsDestination": { "title": "No Ans Ext Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "noAnsExtCallsCss": { "title": "No Ans Ext Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "noCoverageIntCallsDestination": { "title": "No Coverage Int Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "noCoverageIntCallsCss": { "title": "No Coverage Int Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "noCoverageExtCallsDestination": { "title": "No Coverage Ext Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "noCoverageExtCallsCss": { "title": "No Coverage Ext Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "unregisteredIntCallsDestination": { "title": "Unregistered Int Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "unregisteredIntCallsCss": { "title": "Unregistered Int Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "unregisteredExtCallsDestination": { "title": "Unregistered Ext Calls Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "unregisteredExtCallsCss": { "title": "Unregistered Ext Calls Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "ctiFailureDestination": { "title": "Cti Failure Destination", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "ctiFailureCss": { "title": "Cti Failure Css", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/Css", "choices": [] }, "callControlAgentProfile": { "title": "Call Control Agent Profile", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "noAnswerRingDuration": { "title": "No Answer Ring Duration", "minItems": 0, "required": false, "maxItems": 1, "type": [ "integer", "null" ] }, "enterpriseAltNum": { "title": "Enterprise Alt Num", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "member": { "name": "member", "title": "Member", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "numberMask": { "name": "numberMask", "title": "Number Mask", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "addToLocalRoutePartition": { "name": "addToLocalRoutePartition", "title": "Add To Local Route Partition", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "routePartition": { "name": "routePartition", "title": "Route Partition", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/RoutePartition", "choices": [] }, "isUrgent": { "name": "isUrgent", "title": "Is Urgent", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "advertiseGloballyIls": { "name": "advertiseGloballyIls", "title": "Advertise Globally Ils", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } } } }, "e164AltNum": { "title": "E164Alt Num", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "member": { "name": "member", "title": "Member", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "numberMask": { "name": "numberMask", "title": "Number Mask", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "addToLocalRoutePartition": { "name": "addToLocalRoutePartition", "title": "Add To Local Route Partition", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "routePartition": { "name": "routePartition", "title": "Route Partition", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ], "format": "uri", "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "device/cucm/RoutePartition", "choices": [] }, "isUrgent": { "name": "isUrgent", "title": "Is Urgent", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "advertiseGloballyIls": { "name": "advertiseGloballyIls", "title": "Advertise Globally Ils", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } } } }, "advertisedFailoverNumber": { "title": "Advertised Failover Number", "minItems": 0, "required": false, "maxItems": 1, "type": "string" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cucm/UniversalLineTemplate/add/ |
|
The GUI Add form of device/cucm/UniversalLineTemplate 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/UniversalLineTemplate | 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/UniversalLineTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/UniversalLineTemplate/[pkid1]", "/api/device/cucm/UniversalLineTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cucm/UniversalLineTemplate/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cucm/UniversalLineTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/UniversalLineTemplate/[pkid1]", "/api/v0/device/cucm/UniversalLineTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/UniversalLineTemplate/?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/UniversalLineTemplate |
|
{"hrefs": ["/api/device/cucm/UniversalLineTemplate/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/UniversalLineTemplate |
|
{"hrefs": ["/api/device/cucm/UniversalLineTemplate/[pkid1]", "/api/device/cucm/UniversalLineTemplate/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/UniversalLineTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/UniversalLineTemplate/export/ |
|
{ "hrefs":["/api/device/cucm/UniversalLineTemplate/[pkid1]", "/api/device/cucm/UniversalLineTemplate/[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/UniversalLineTemplate and the JSON format can be used to import instances of device/cucm/UniversalLineTemplate.
GET http://[host-proxy]/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/UniversalLineTemplate | POST | /api/device/cucm/UniversalLineTemplate/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/UniversalLineTemplate/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/UniversalLineTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cucm/UniversalLineTemplate/ |
|
The device/cucm/UniversalLineTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/UniversalLineTemplate instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 1, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/device/cucm/UniversalLineTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=down" }, "operations": [ "export", "help", "update", "get", "move", "remove", "list", "configuration_template", "export_bulkload_template", "transform", "clone", "field_display_policy", "bulk_update_form", "add" ], "meta": { "model_type": "device/cucm/UniversalLineTemplate", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "lineDescription", "title": "Line Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true }, { "name": "summary_device", "title": "Device", "allow_filtering": false } ], "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": [ "export", "help", "update", "get", "move", "remove", "list", "configuration_template", "export_bulkload_template", "clone", "field_display_policy", "bulk_update_form", "add" ], "schema_version": "14.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/device/cucm/UniversalLineTemplate/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/device/cucm/UniversalLineTemplate/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/UniversalLineTemplate", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "method": "POST", "class": "export", "href": "/api/device/cucm/UniversalLineTemplate/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/device/cucm/UniversalLineTemplate/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/device/cucm/UniversalLineTemplate/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/device/cucm/UniversalLineTemplate/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "list": { "method": "GET", "class": "list", "href": "/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/cucm/UniversalLineTemplate/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/cucm/UniversalLineTemplate/purge/?hierarchy=[hierarchy]", "support_async": false, "title": "Purge" } } ] }, "resources": [ { "data": { "mlppNoAnsRingDuration": null, "noCoverageIntCallsDestination": null, "blfPresenceGroup": "Standard Presence group", "partyEntranceTone": "Default", "aarGroup": null, "voiceMailProfile": null, "busyExtCallsCss": null, "unregisteredExtCallsDestination": null, "autoAnswer": "Auto Answer Off", "mlppCss": null, "busyIntCallsCss": null, "unregisteredExtCallsCss": null, "ctiFailureCss": null, "ctiFailureDestination": null, "rejectAnonymousCall": false, "noCoverageExtCallsCss": null, "busyIntCallsDestination": null, "aarDestinationMask": null, "callingSearchSpace": null, "fwdDestExtCallsWhenNotRetrieved": "Revert to Originator", "noCoverageIntCallsCss": null, "name": "Sample Line Template with TAG usage examples", "CssActivationPolicy": "Use System Default", "noAnsIntCallsCss": null, "routePartition": null, "retainDestInCallFwdHistory": true, "unregisteredIntCallsDestination": null, "alertingName": "#FirstName# #LastName#", "cssFwdInternalCallsWhenNotRetrieved": null, "busyExtCallsDestination": null, "noAnsExtCallsCss": null, "parkMonitorReversionTime": null, "cssFwdExtCallsWhenNotRetrieved": null, "noCoverageExtCallsDestination": null, "extCallControlProfile": null, "fwdDestInternalCallsWhenNotRetrieved": "Revert to Originator", "holdReversionNotificationInterval": null, "e164AltNum": null, "lineDescription": "#FirstName# #LastName# (#UserID#)", "forwardDestAllCalls": null, "holdReversionRingDuration": null, "noAnsExtCallsDestination": null, "enterpriseAltNum": null, "secondaryCssForwardingAllCalls": null, "userHoldMohAudioSource": null, "primaryCssForwardingAllCalls": null, "networkHoldMohAudioSource": null, "noAnsIntCallsDestination": null, "target": null, "unregisteredIntCallsCss": null, "urgentPriority": false, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" }, "meta": { "model_type": "device/cucm/UniversalLineTemplate", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "lineDescription", "title": "Line Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true }, { "name": "summary_device", "title": "Device", "allow_filtering": false } ], "tagged_versions": [], "tags": [], "title": "Sample Line Template with TAG usage examples", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "/api/v0/data/CallManager/5df0b693ce894e001275c115", "pkid": "5df0b693ce894e001275c115" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5df0b66bce894e001275a913", "href": "/api/data/HierarchyNode/5df0b66bce894e001275a913" } ], "foreign_key": [], "self": [ { "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/", "pkid": "5df0babfce894e00127710fa" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5da4c643ce894e0012225c90", "5df0b338ce894e001275535c", "5df0b3a3ce894e0012756904", "5df0b66bce894e001275a913", "5df0babfce894e00127710fa" ], "schema_version": "", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/5df0babfce894e00127710fa/?model_type=device/cucm/UniversalLineTemplate", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/" } }, { "export": { "method": "GET", "class": "export", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "get": { "method": "GET", "class": "get", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/help", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/purge/", "support_async": false, "title": "Purge" } } ], "summary": "false" }, "pkid": "5df0babfce894e00127710fa" } ] }
(Show the first instance)
{ "data": { "name": "Sample Line Template with TAG usage examples", "urgentPriority": false, "lineDescription": "#FirstName# #LastName# (#UserID#)", "routePartition": null, "voiceMailProfile": null, "callingSearchSpace": null, "alertingName": "#FirstName# #LastName#", "extCallControlProfile": null, "blfPresenceGroup": "Standard Presence group", "partyEntranceTone": "Default", "autoAnswer": "Auto Answer Off", "rejectAnonymousCall": false, "userHoldMohAudioSource": null, "networkHoldMohAudioSource": null, "aarDestinationMask": null, "aarGroup": null, "retainDestInCallFwdHistory": true, "forwardDestAllCalls": null, "primaryCssForwardingAllCalls": null, "secondaryCssForwardingAllCalls": null, "CssActivationPolicy": "Use System Default", "fwdDestExtCallsWhenNotRetrieved": "Revert to Originator", "cssFwdExtCallsWhenNotRetrieved": null, "fwdDestInternalCallsWhenNotRetrieved": "Revert to Originator", "cssFwdInternalCallsWhenNotRetrieved": null, "parkMonitorReversionTime": null, "target": null, "mlppCss": null, "mlppNoAnsRingDuration": null, "holdReversionRingDuration": null, "holdReversionNotificationInterval": null, "busyIntCallsDestination": null, "busyIntCallsCss": null, "busyExtCallsDestination": null, "busyExtCallsCss": null, "noAnsIntCallsDestination": null, "noAnsIntCallsCss": null, "noAnsExtCallsDestination": null, "noAnsExtCallsCss": null, "noCoverageIntCallsDestination": null, "noCoverageIntCallsCss": null, "noCoverageExtCallsDestination": null, "noCoverageExtCallsCss": null, "unregisteredIntCallsDestination": null, "unregisteredIntCallsCss": null, "unregisteredExtCallsDestination": null, "unregisteredExtCallsCss": null, "ctiFailureDestination": null, "ctiFailureCss": null, "enterpriseAltNum": null, "e164AltNum": null }, "meta": { "model_type": "device/cucm/UniversalLineTemplate", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "lineDescription", "title": "Line Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true }, { "name": "summary_device", "title": "Device", "allow_filtering": false } ], "tagged_versions": [], "tags": [], "title": "Sample Line Template with TAG usage examples", "business_key": {}, "api_version": "21.2", "cached": true, "cache_control_policy": "cache_then_device", "references": { "device": [ { "href": "/api/v0/data/CallManager/5df0b693ce894e001275c115", "pkid": "5df0b693ce894e001275c115" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/5df0b66bce894e001275a913", "pkid": "5df0b66bce894e001275a913" } ], "foreign_key": [], "children": [], "self": [ { "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/", "pkid": "5df0babfce894e00127710fa" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5da4c643ce894e0012225c90", "5df0b338ce894e001275535c", "5df0b3a3ce894e0012756904", "5df0b66bce894e001275a913", "5df0babfce894e00127710fa" ], "schema_version": "11.5", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/5df0babfce894e00127710fa/?hierarchy=[hierarchy]&model_type=device/cucm/UniversalLineTemplate", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "method": "GET", "class": "export", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "get": { "method": "GET", "class": "get", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/cucm/UniversalLineTemplate/5df0babfce894e00127710fa/purge/?hierarchy=[hierarchy]", "support_async": false, "title": "Purge" } } ] }, "pkid": "5df0babfce894e00127710fa" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cucm/UniversalLineTemplate. | GET | /api/device/cucm/UniversalLineTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/UniversalLineTemplate as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Purge | POST | /api/device/cucm/UniversalLineTemplate/purge/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cucm/UniversalLineTemplate/[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/UniversalLineTemplate/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/UniversalLineTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/UniversalLineTemplate | 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/UniversalLineTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/UniversalLineTemplate/[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/UniversalLineTemplate and the JSON format can be used to import instances of device/cucm/UniversalLineTemplate.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cucm/UniversalLineTemplate/[pkid] | hierarchy=[hierarchy] | The device/cucm/UniversalLineTemplate instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cucm/UniversalLineTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/UniversalLineTemplate. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cucm/UniversalLineTemplate/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |