[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": {
"mlppNoAnsRingDuration": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Mlpp No Ans Ring Duration"
},
"noCoverageIntCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "No Coverage Int Calls Destination"
},
"blfPresenceGroup": {
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/PresenceGroup",
"title": "Blf Presence Group",
"type": "string"
},
"partyEntranceTone": {
"title": "Party Entrance Tone",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"aarGroup": {
"target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/AarGroup",
"title": "Aar Group",
"type": [
"string",
"null"
]
},
"voiceMailProfile": {
"target": "/api/device/cucm/VoiceMailProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/VoiceMailProfile",
"title": "Voice Mail Profile",
"type": [
"string",
"null"
]
},
"busyExtCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Busy Ext Calls Css",
"type": [
"string",
"null"
]
},
"unregisteredExtCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Unregistered Ext Calls Destination"
},
"autoAnswer": {
"title": "Auto Answer",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Auto Answer Off",
"title": "Auto Answer Off"
},
{
"value": "Auto Answer with Headset",
"title": "Auto Answer with Headset"
},
{
"value": "Auto Answer with Speakerphone",
"title": "Auto Answer with Speakerphone"
}
],
"default": "Auto Answer Off",
"maxItems": 1,
"type": "string"
},
"mlppCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Mlpp Css",
"type": [
"string",
"null"
]
},
"busyIntCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Busy Int Calls Css",
"type": [
"string",
"null"
]
},
"unregisteredExtCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Unregistered Ext Calls Css",
"type": [
"string",
"null"
]
},
"ctiFailureCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Cti Failure Css",
"type": [
"string",
"null"
]
},
"ctiFailureDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Cti Failure Destination"
},
"rejectAnonymousCall": {
"minItems": 0,
"required": false,
"type": "boolean",
"maxItems": 1,
"title": "Reject Anonymous Call"
},
"noCoverageExtCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "No Coverage Ext Calls Css",
"type": [
"string",
"null"
]
},
"busyIntCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Busy Int Calls Destination"
},
"aarDestinationMask": {
"title": "Aar Destination Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": [
"string",
"null"
]
},
"fwdDestExtCallsWhenNotRetrieved": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Fwd Dest Ext Calls When Not Retrieved"
},
"noCoverageIntCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "No Coverage Int Calls Css",
"type": [
"string",
"null"
]
},
"name": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Name"
},
"CssActivationPolicy": {
"title": "Css Activation Policy",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "With Configured CSS",
"title": "With Configured CSS"
},
{
"value": "With Activating Device/Line CSS",
"title": "With Activating Device/Line CSS"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": "string"
},
"noAnsIntCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "No Ans Int Calls Css",
"type": [
"string",
"null"
]
},
"routePartition": {
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"title": "Route Partition",
"type": [
"string",
"null"
]
},
"retainDestInCallFwdHistory": {
"minItems": 0,
"required": false,
"type": "boolean",
"maxItems": 1,
"title": "Retain Dest In Call Fwd History"
},
"callPickupGroup": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Call Pickup Group"
},
"unregisteredIntCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Unregistered Int Calls Destination"
},
"advertisedFailoverNumber": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Advertised Failover Number"
},
"alertingName": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Alerting Name"
},
"cssFwdInternalCallsWhenNotRetrieved": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Css Fwd Internal Calls When Not Retrieved",
"type": [
"string",
"null"
]
},
"busyExtCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Busy Ext Calls Destination"
},
"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": {
"routePartition": {
"name": "routePartition",
"format": "uri",
"minItems": 0,
"title": "Route Partition",
"required": false,
"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]
},
"advertiseGloballyIls": {
"name": "advertiseGloballyIls",
"title": "Advertise Globally Ils",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"addToLocalRoutePartition": {
"name": "addToLocalRoutePartition",
"title": "Add To Local Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"numberMask": {
"name": "numberMask",
"title": "Number Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"isUrgent": {
"name": "isUrgent",
"title": "Is Urgent",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
}
}
},
"noAnsExtCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "No Ans Ext Calls Css",
"type": [
"string",
"null"
]
},
"callingSearchSpace": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Calling Search Space",
"type": [
"string",
"null"
]
},
"parkMonitorReversionTime": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Park Monitor Reversion Time"
},
"callControlAgentProfile": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Call Control Agent Profile"
},
"noAnswerRingDuration": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "No Answer Ring Duration"
},
"extCallControlProfile": {
"target": "/api/device/cucm/CallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/CallControlProfile",
"title": "Ext Call Control Profile",
"type": [
"string",
"null"
]
},
"fwdDestInternalCallsWhenNotRetrieved": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Fwd Dest Internal Calls When Not Retrieved"
},
"holdReversionNotificationInterval": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Hold Reversion Notification Interval"
},
"noCoverageExtCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "No Coverage Ext Calls Destination"
},
"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": {
"routePartition": {
"name": "routePartition",
"format": "uri",
"minItems": 0,
"title": "Route Partition",
"required": false,
"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]
},
"advertiseGloballyIls": {
"name": "advertiseGloballyIls",
"title": "Advertise Globally Ils",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"addToLocalRoutePartition": {
"name": "addToLocalRoutePartition",
"title": "Add To Local Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"numberMask": {
"name": "numberMask",
"title": "Number Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"isUrgent": {
"name": "isUrgent",
"title": "Is Urgent",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
}
}
},
"lineDescription": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Line Description"
},
"forwardDestAllCalls": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Forward Dest All Calls"
},
"holdReversionRingDuration": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Hold Reversion Ring Duration"
},
"noAnsExtCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "No Ans Ext Calls Destination"
},
"target": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Target"
},
"secondaryCssForwardingAllCalls": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Secondary Css Forwarding All Calls",
"type": [
"string",
"null"
]
},
"userHoldMohAudioSource": {
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"title": "User Hold Moh Audio Source",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"type": [
"string",
"null",
"integer"
]
},
"primaryCssForwardingAllCalls": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Primary Css Forwarding All Calls",
"type": [
"string",
"null"
]
},
"networkHoldMohAudioSource": {
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"title": "Network Hold Moh Audio Source",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"type": [
"string",
"null",
"integer"
]
},
"noAnsIntCallsDestination": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "No Ans Int Calls Destination"
},
"cssFwdExtCallsWhenNotRetrieved": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Css Fwd Ext Calls When Not Retrieved",
"type": [
"string",
"null"
]
},
"unregisteredIntCallsCss": {
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Unregistered Int Calls Css",
"type": [
"string",
"null"
]
},
"urgentPriority": {
"minItems": 0,
"required": false,
"type": "boolean",
"maxItems": 1,
"title": "Urgent Priority"
}
},
"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)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"transform",
"add",
"export",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/UniversalLineTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"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/UniversalLineTemplate/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/UniversalLineTemplate/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/UniversalLineTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/UniversalLineTemplate/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/UniversalLineTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/UniversalLineTemplate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/UniversalLineTemplate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/UniversalLineTemplate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/UniversalLineTemplate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/UniversalLineTemplate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/UniversalLineTemplate",
"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": "Name"
},
{
"name": "lineDescription",
"title": "Line Description"
},
{
"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": "5f3aeb06ce894e001206b214",
"meta": {
"tags": [],
"cached": true,
"title": "Sample Line Template with TAG usage examples",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3aeb06ce894e001206b214",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3aeb06ce894e001206b214/?model_type=device/cucm/UniversalLineTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/UniversalLineTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3aeb06ce894e001206b214"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "lineDescription",
"title": "Line Description"
},
{
"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": {
"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,
"hierarchy_friendly_name": "AB_Group (Customer)",
"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,
"enterpriseAltNum": null,
"noAnsExtCallsCss": null,
"parkMonitorReversionTime": null,
"noCoverageExtCallsDestination": null,
"extCallControlProfile": null,
"fwdDestInternalCallsWhenNotRetrieved": "Revert to Originator",
"holdReversionNotificationInterval": null,
"e164AltNum": null,
"lineDescription": "#FirstName# #LastName# (#UserID#)",
"forwardDestAllCalls": null,
"holdReversionRingDuration": null,
"noAnsExtCallsDestination": null,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"target": null,
"secondaryCssForwardingAllCalls": null,
"userHoldMohAudioSource": null,
"primaryCssForwardingAllCalls": null,
"networkHoldMohAudioSource": null,
"noAnsIntCallsDestination": null,
"cssFwdExtCallsWhenNotRetrieved": null,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"unregisteredIntCallsCss": null,
"urgentPriority": false
}
}
]
}
(Show the first instance)
{
"pkid": "5f3aeb06ce894e001206b214",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Sample Line Template with TAG usage examples",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3aeb06ce894e001206b214",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3aeb06ce894e001206b214/?hierarchy=[hierarchy]&model_type=device/cucm/UniversalLineTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/UniversalLineTemplate/5f3aeb06ce894e001206b214/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/UniversalLineTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3aeb06ce894e001206b214"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "lineDescription",
"title": "Line Description"
},
{
"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": {
"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,
"enterpriseAltNum": null,
"noAnsExtCallsCss": null,
"parkMonitorReversionTime": null,
"noCoverageExtCallsDestination": null,
"extCallControlProfile": null,
"fwdDestInternalCallsWhenNotRetrieved": "Revert to Originator",
"holdReversionNotificationInterval": null,
"e164AltNum": null,
"lineDescription": "#FirstName# #LastName# (#UserID#)",
"forwardDestAllCalls": null,
"holdReversionRingDuration": null,
"noAnsExtCallsDestination": null,
"target": null,
"secondaryCssForwardingAllCalls": null,
"userHoldMohAudioSource": null,
"primaryCssForwardingAllCalls": null,
"networkHoldMohAudioSource": null,
"noAnsIntCallsDestination": null,
"cssFwdExtCallsWhenNotRetrieved": null,
"unregisteredIntCallsCss": null,
"urgentPriority": false
}
}
| 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 | 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: |