[Index]
Adds line and updates INI
Model ref.: view/AddLine_VIEW
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": { "partyEntranceTone": { "default": "Default", "choices": [ { "value": "Off", "title": "Off" }, { "value": "On", "title": "On" }, { "value": "Default", "title": "Default" } ], "type": "string", "title": "partyEntranceTone" }, "cfaCssPolicy": { "default": "Use System Default", "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" } ], "type": "string", "title": "cfaCssPolicy" }, "callForwardBusyInt": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Forward Busy Internal Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward Busy Internal Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward Busy Internal Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward Busy Int" }, "iniDescription": { "type": "string", "title": "Number Inventory Description" }, "userHoldMohAudioSourceId": { "target_attr": "sourceId", "format": "uri", "type": "integer", "target": "device/cucm/MohAudioSource", "title": "User Hold MOH Audio Source" }, "callForwardNotRegisteredInt": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Call Forward Unregistered Internal Destination Mask" }, "forwardToVoiceMail": { "type": "boolean", "title": "Call Forward Unregistered Internal voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward Unregistered CSS Internal", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward Not Registered Int" }, "routePartitionName": { "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Route Partition", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/RoutePartition", "type": "string" }, "callForwardOnFailure": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Device Failure Directory Number" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward CTI Failure Voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Device Failure Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward On Failure" }, "rejectAnonymousCall": { "type": "boolean", "title": "Reject Anonymous Calls" }, "allowCtiControlFlag": { "type": "boolean", "title": "Allow Control of Device from CTI" }, "shareLineAppearanceCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" }, "aarDestinationMask": { "pattern": "^[0-9*#+X]{0,24}$", "maxLength": 24, "type": "string", "title": "AAR Destination Mask" }, "callPickupGroupName": { "target": "/api/device/cucm/CallPickupGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Call Pickup Group", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/CallPickupGroup", "type": "string" }, "pattern": { "target": "/api/data/InternalNumberInventory/choices/?field=internal_number&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "required": true, "choices": [], "target_attr": "internal_number", "target_model_type": "data/InternalNumberInventory", "title": "Directory Number", "type": "string" }, "patternPrecedence": { "default": "Default", "choices": [ { "value": "Flash Override", "title": "Flash Override" }, { "value": "Flash", "title": "Flash" }, { "value": "Immediate", "title": "Immediate" }, { "value": "Priority", "title": "Priority" }, { "value": "Routine", "title": "Routine" }, { "value": "Default", "title": "Default" }, { "value": "Executive Override", "title": "Executive Override" } ], "type": "string", "title": "Pattern Precedence" }, "presenceGroupName": { "target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "BLF Presence Group", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/PresenceGroup", "type": "string" }, "callForwardNoAnswer": { "type": "object", "properties": { "duration": { "type": "integer", "title": "callForwardNoAnswer.Duration" }, "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Forward No Answer External Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward No Answer Voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward No Answer External Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward No Answer" }, "hrInterval": { "type": "integer", "title": "Hold Reversion Notification Interval (seconds)" }, "callForwardNoCoverage": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Forward No Coverage External Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward No Coverage External Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward No Coverage External Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward No Coverage" }, "callForwardNotRegistered": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Call Forward Unregistered External Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Call Forward Unregistered External Voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Call Forward Unregistered CSS External", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward Not Registered" }, "usage": { "choices": [ { "value": "CallPark", "title": "CallPark" }, { "value": "Conference", "title": "Conference" }, { "value": "Device", "title": "Device" }, { "value": "Translation", "title": "Translation" }, { "value": "Call Pick Up Group", "title": "Call Pick Up Group" }, { "value": "Route", "title": "Route" }, { "value": "Message Waiting", "title": "Message Waiting" }, { "value": "Hunt Pilot", "title": "Hunt Pilot" }, { "value": "Voice Mail Port", "title": "Voice Mail Port" }, { "value": "Domain Routing", "title": "Domain Routing" }, { "value": "IPAddress Routing", "title": "IPAddress Routing" }, { "value": "Device template", "title": "Device template" }, { "value": "Directed Call Park", "title": "Directed Call Park" }, { "value": "Device Intercom", "title": "Device Intercom" }, { "value": "Translation Intercom", "title": "Translation Intercom" }, { "value": "Translation Calling Party Number", "title": "Translation Calling Party Number" }, { "value": "Mobility Handoff", "title": "Mobility Handoff" }, { "value": "Mobility Enterprise Feature Access", "title": "Mobility Enterprise Feature Access" }, { "value": "Mobility IVR", "title": "Mobility IVR" }, { "value": "Device Intercom Template", "title": "Device Intercom Template" }, { "value": "Called Party Number Transformation", "title": "Called Party Number Transformation" }, { "value": "Call Control Discovery Learned Pattern", "title": "Call Control Discovery Learned Pattern" }, { "value": "Uri Routing", "title": "Uri Routing" }, { "value": "ILS Learned Enterprise Number", "title": "ILS Learned Enterprise Number" }, { "value": "ILS Learned E164 Number", "title": "ILS Learned E164 Number" }, { "value": "ILS Learned Enterprise Numeric Pattern", "title": "ILS Learned Enterprise Numeric Pattern" }, { "value": "ILS Learned E164 Numeric Pattern", "title": "ILS Learned E164 Numeric Pattern" }, { "value": "Alternate Number", "title": "Alternate Number" }, { "value": "ILS Learned URI", "title": "ILS Learned URI" }, { "value": "ILS Learned PSTN Failover Rule", "title": "ILS Learned PSTN Failover Rule" }, { "value": "ILS Imported E164 Number", "title": "ILS Imported E164 Number" }, { "value": "Centralized Conference Number", "title": "Centralized Conference Number" }, { "value": "Emergency Location ID Number", "title": "Emergency Location ID Number" } ], "required": true, "type": "string", "title": "Usage" }, "hrDuration": { "type": "integer", "title": "Hold Reversion Ring Duration (seconds)" }, "parkMonForwardNoRetrieveVmEnabled": { "type": "boolean", "title": "Park Mon Forward No Retrieve Vm Enabled" }, "alertingName": { "maxLength": 50, "type": "string", "title": "Alerting Name" }, "description": { "type": "string", "title": "Description" }, "directoryURIs": { "type": "object", "properties": { "directoryUri": { "items": { "type": "object", "properties": { "isPrimary": { "required": true, "type": "boolean", "title": "Is Primary" }, "uri": { "maxLength": 128, "required": true, "type": "string", "title": "Uri" }, "advertiseGloballyViaIls": { "type": "boolean", "title": "Advertise Globally Via Ils" }, "partition": { "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "required": true, "choices": [], "target_attr": "name", "target_model_type": "device/cucm/RoutePartition", "title": "Partition", "type": "string" } } }, "type": "array", "title": "Directory Uri" } }, "title": "Directory URIs" }, "iniTag": { "type": "string", "title": "Number Inventory Tag" }, "aarVoiceMailEnabled": { "type": "boolean", "title": "AAR Voice Mail Enabled" }, "parkMonForwardNoRetrieveIntCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Calling Search Space No Retrieve Internal", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" }, "parkMonForwardNoRetrieveDn": { "pattern": "^[0-9*#+X]{0,50}$", "maxLength": 50, "type": "string", "title": "Park Monitoring Forward No Retrieve Destination External" }, "aarKeepCallHistory": { "type": "boolean", "title": "Retain this destination in the call forwarding history" }, "defaultActivatedDeviceName": { "type": "string", "title": "Default Activated Device Name" }, "parkMonReversionTimer": { "type": "integer", "title": "Park Monitoring Reversion Timer" }, "releaseClause": { "default": "No Error", "choices": [ { "value": "No Error", "title": "No Error" }, { "value": "Unallocated Number", "title": "Unallocated Number" }, { "value": "Call Rejected", "title": "Call Rejected" }, { "value": "Number Changed", "title": "Number Changed" }, { "value": "Invalid Number Format", "title": "Invalid Number Format" }, { "value": "Precedence Level Exceeded", "title": "Precedence Level Exceeded" } ], "type": "string", "title": "Release Clause" }, "e164AltNum": { "type": "object", "properties": { "isUrgent": { "type": "boolean", "title": "E164Alt Is Urgent" }, "addLocalRoutePartition": { "type": "boolean", "title": "E164Alt Add Local Route Partition" }, "advertiseGloballyIls": { "type": "boolean", "title": "E164Alt Advertise Globally Ils" }, "routePartition": { "type": "string", "title": "E164Alt RoutePartition" }, "numMask": { "type": "string", "title": "E164Alt Num Mask" } }, "title": "E164Alt Num" }, "callForwardAll": { "type": "object", "properties": { "secondaryCallingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Secondary Calling Search Space for Forward All", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" }, "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Forward All Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward All Voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward All Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward All" }, "parkMonForwardNoRetrieveCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Calling Search Space No Retrieve External", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" }, "active": { "type": "boolean", "title": "Active" }, "voiceMailProfileName": { "target": "/api/device/cucm/VoiceMailProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Voice Mail Profile", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/VoiceMailProfile", "type": "string" }, "useEnterpriseAltNum": { "type": "boolean", "title": "Use Enterprise Alt Num" }, "callForwardBusy": { "type": "object", "properties": { "destination": { "minLength": 1, "maxLength": 50, "type": "string", "title": "Forward Busy External Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward Busy Voice Mail Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward Busy External Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward Busy" }, "parkMonForwardNoRetrieveIntDn": { "pattern": "^[0-9*#+X]{0,50}$", "maxLength": 50, "type": "string", "title": "Park Monitoring Forward No Retrieve Destination Internal" }, "enterpriseAltNum": { "type": "object", "properties": { "isUrgent": { "type": "boolean", "title": "Ent Is Urgent" }, "addLocalRoutePartition": { "type": "boolean", "title": "Ent Add Local Route Partition" }, "advertiseGloballyIls": { "type": "boolean", "title": "Ent Advertise Globally Ils" }, "routePartition": { "type": "string", "title": "Ent RoutePartition" }, "numMask": { "type": "string", "title": "Ent Num Mask" } }, "title": "Enterprise Alt Num" }, "autoAnswer": { "default": "Auto Answer Off", "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" } ], "type": "string", "title": "Auto Answer" }, "callForwardNoAnswerInt": { "type": "object", "properties": { "destination": { "maxLength": 50, "type": "string", "title": "Forward No Answer Internal Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward No Answer Internal Enabled" }, "duration_int": { "type": "integer", "title": "callForwardNoAnswerInt.Duration" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward No Answer Internal Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward No Answer Int" }, "asciiAlertingName": { "maxLength": 32, "type": "string", "title": "ASCII Alerting Name" }, "networkHoldMohAudioSourceId": { "target_attr": "sourceId", "format": "uri", "type": "integer", "target": "device/cucm/MohAudioSource", "title": "Network Hold MOH Audio Source" }, "patternUrgency": { "type": "boolean", "title": "Pattern Urgency" }, "aarNeighborhoodName": { "target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "AAR Group", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/AarGroup", "type": "string" }, "parkMonForwardNoRetrieveIntVmEnabled": { "type": "boolean", "title": "Park Mon Forward No Retrieve Int Vm Enabled" }, "callForwardNoCoverageInt": { "type": "object", "properties": { "destination": { "maxLength": 50, "type": "string", "title": "Forward No Coverage Internal Destination" }, "forwardToVoiceMail": { "type": "boolean", "title": "Forward No Coverage Internal Enabled" }, "callingSearchSpaceName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Forward No Coverage Internal Calling Search Space", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/Css", "type": "string" } }, "title": "Call Forward No Coverage Int" }, "useE164AltNum": { "type": "boolean", "title": "Use E164Alt Num" }, "externalCallControlProfile": { "target": "/api/device/cucm/ExternalCallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "External Call Control Profile", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/ExternalCallControlProfile", "type": "string" } } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/view/AddLine_VIEW/add/ |
|
The GUI Add form of view/AddLine_VIEW 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/view/AddLine_VIEW | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for view/AddLine_VIEW | POST | /api/view/AddLine_VIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/view/AddLine_VIEW/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/view/AddLine_VIEW/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/view/AddLine_VIEW/ |
|
The view/AddLine_VIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/AddLine_VIEW instances)
{ "operations": [ "add", "help", "configuration_template", "field_display_policy", "export_bulkload_template", "transform" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/view/AddLine_VIEW/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": null, "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/view/AddLine_VIEW/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/view/AddLine_VIEW/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/view/AddLine_VIEW/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/view/AddLine_VIEW/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/view/AddLine_VIEW/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } } ], "model_type": "view/AddLine_VIEW", "model_specific_actions": [ "add" ], "summary_attrs": [ { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/view/AddLine_VIEW/[pkid] | hierarchy=[hierarchy] | The view/AddLine_VIEW instance with [pkid]. |