API Reference for device/cuc/UserPrimaryCallHandler

Model ref.: device/cuc/UserPrimaryCallHandler

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "VoiceName": {
               "minItems": 0, 
               "title": "Voice Name", 
               "type": "string", 
               "description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.", 
               "name": "VoiceName"
          }, 
          "DisplayName": {
               "minItems": 0, 
               "title": "Display Name", 
               "type": "string", 
               "description": " The text name of the handler to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting call handler is \"Opening Greeting.\"", 
               "name": "DisplayName"
          }, 
          "PlayPostGreetingRecording": {
               "minItems": 0, 
               "title": "Play Post Greeting Recording", 
               "type": "integer", 
               "description": " Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.", 
               "name": "PlayPostGreetingRecording"
          }, 
          "CreationTime": {
               "minItems": 0, 
               "title": "Creation Time", 
               "type": "string", 
               "description": " The date and time the handler is created.", 
               "name": "CreationTime"
          }, 
          "CallHandlerOwnerURI": {
               "title": "Call Handler Owner URI", 
               "type": "string", 
               "description": "The URI to fetch the call  handler owners.", 
               "name": "CallHandlerOwnerURI"
          }, 
          "EnablePrependDigits": {
               "minItems": 0, 
               "title": "Enable Prepend Digits", 
               "type": "boolean", 
               "description": " A flag to indicate weather or not to prepend digits when dialing a extension number to transfer too.\n\n", 
               "name": "EnablePrependDigits"
          }, 
          "UseDefaultTimeZone": {
               "minItems": 0, 
               "title": "Use Default Time Zone", 
               "type": "boolean", 
               "description": "A flag indicating whether the timezone for this call handler is derived from the call handler object attribute or the default timezone from the location to which the call handler belongs. Always use the Timezone column - if this is set, then the column Timezone is being derived directly from the location.", 
               "name": "UseDefaultTimeZone"
          }, 
          "PhoneSystemURI": {
               "name": "PhoneSystemURI", 
               "title": "Phone System URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "RecipientDistributionListURI": {
               "name": "RecipientDistributionListURI", 
               "title": "Recipient Distribution List URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "TimeZone": {
               "minItems": 0, 
               "title": "Time Zone", 
               "type": "integer", 
               "description": " TimeZone this call handler is operating in.", 
               "name": "TimeZone"
          }, 
          "PartitionURI": {
               "name": "PartitionURI", 
               "title": "Partition URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "ScheduleSetURI": {
               "name": "ScheduleSetURI", 
               "title": "Schedule Set URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "PartitionObjectId": {
               "minItems": 0, 
               "title": "Partition Object Id", 
               "type": "string", 
               "description": " The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.", 
               "name": "PartitionObjectId"
          }, 
          "RecipientSubscriberObjectId": {
               "description": " The recipient for this call handler. If the recipient is a subscriber, the DignetObjectId of the User object to which the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL. - template parameter [1]", 
               "name": "RecipientSubscriberObjectId", 
               "format": "uri", 
               "minItems": 0, 
               "required": true, 
               "choices": [], 
               "target_attr": "ObjectId", 
               "target_model_type": "device/cuc/User", 
               "title": "Recipient Subscriber Object Id", 
               "type": [
                    "string"
               ], 
               "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "CallSearchSpaceObjectId": {
               "minItems": 0, 
               "title": "Call Search Space Object Id", 
               "type": "string", 
               "description": " The unique identifier of the SearchSpace that is used limit visibility to dialable objects when searching by extension (dial string).", 
               "name": "CallSearchSpaceObjectId"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a CallHandler object.", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "UseCallLanguage": {
               "minItems": 0, 
               "title": "Use Call Language", 
               "type": "boolean", 
               "description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.", 
               "name": "UseCallLanguage"
          }, 
          "TransferOptionsURI": {
               "name": "TransferOptionsURI", 
               "title": "Transfer Options URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "ScheduleSetObjectId": {
               "minItems": 0, 
               "title": "Schedule Set Object Id", 
               "type": "string", 
               "description": " The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.", 
               "name": "ScheduleSetObjectId"
          }, 
          "OneKeyDelay": {
               "minItems": 0, 
               "title": "One Key Delay", 
               "type": "integer", 
               "description": " The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key.", 
               "name": "OneKeyDelay"
          }, 
          "DispatchDelivery": {
               "minItems": 0, 
               "title": "Dispatch Delivery", 
               "type": "boolean", 
               "description": " A flag indicating that all messages left for the call handler is for dispatch delivery. ", 
               "name": "DispatchDelivery"
          }, 
          "VoiceNameURI": {
               "name": "VoiceNameURI", 
               "title": "Voice Name URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "AfterMessageAction": {
               "minItems": 0, 
               "title": "After Message Action", 
               "type": "integer", 
               "description": " The type of call action to take, e.g., hang-up, goto another object, etc.", 
               "name": "AfterMessageAction"
          }, 
          "DtmfAccessId": {
               "minItems": 0, 
               "title": "Dtmf Access Id", 
               "type": "string", 
               "description": "The DTMF access id (i.e., extension) for the call handler. The dialable number.", 
               "name": "DtmfAccessId"
          }, 
          "MaxMsgLen": {
               "minItems": 0, 
               "title": "Max Msg Len", 
               "type": "integer", 
               "description": " The maximum recording length (in seconds) for messages left by unidentified callers.", 
               "name": "MaxMsgLen"
          }, 
          "RecipientContactURI": {
               "name": "RecipientContactURI", 
               "title": "Recipient Contact URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "MenuEntriesURI": {
               "name": "MenuEntriesURI", 
               "title": "Menu Entries URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "IsPrimary": {
               "minItems": 0, 
               "title": "Is Primary", 
               "type": "boolean", 
               "description": " A flag indicating whether this is a \"primary\" call handler for a subscriber, or an \"application\" call handler.", 
               "name": "IsPrimary"
          }, 
          "PrependDigits": {
               "minItems": 0, 
               "title": "Prepend Digits", 
               "type": "string", 
               "description": " Touch-Tone digits to prepended to extension when dialing transfer number  ( #, 0,1...9,*).", 
               "name": "PrependDigits"
          }, 
          "LocationObjectId": {
               "minItems": 0, 
               "title": "Location Object Id", 
               "type": "string", 
               "description": " The unique identifier of the Location object to which this handler belongs.", 
               "name": "LocationObjectId"
          }, 
          "Language": {
               "minItems": 0, 
               "title": "Language", 
               "type": "integer", 
               "description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.", 
               "name": "Language"
          }, 
          "LocalizationKey": {
               "title": "Localization Key", 
               "type": "string", 
               "description": "Localization Key for Timezone update.", 
               "name": "LocalizationKey"
          }, 
          "RecipientUserURI": {
               "name": "RecipientUserURI", 
               "title": "Recipient User URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "IsTemplate": {
               "minItems": 0, 
               "title": "Is Template", 
               "type": "boolean", 
               "description": " A flag indicating whether this CallHandler is a \"template\" for creating new call handlers.", 
               "name": "IsTemplate"
          }, 
          "URI": {
               "name": "URI", 
               "title": "URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "CallSearchSpaceURI": {
               "name": "CallSearchSpaceURI", 
               "title": "Call Search Space URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "PlayAfterMessageRecordingObjectId": {
               "minItems": 0, 
               "title": "Play After Message Recording Object Id", 
               "type": "string", 
               "description": " A Link To a PostGreetingRecording that is used as After Message Recording", 
               "name": "PlayAfterMessageRecordingObjectId"
          }, 
          "EditMsg": {
               "minItems": 0, 
               "title": "Edit Msg", 
               "type": "boolean", 
               "description": " A flag that determines whether the caller can edit messages.", 
               "name": "EditMsg"
          }, 
          "PlayAfterMessage": {
               "minItems": 0, 
               "title": "Play After Message", 
               "type": "integer", 
               "description": " Indicates whether the Sent Message Prompt Recording referenced by Post Greeting", 
               "name": "PlayAfterMessage"
          }, 
          "GreetingsURI": {
               "name": "GreetingsURI", 
               "title": "Greetings URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "AfterMessageTargetHandlerObjectId": {
               "minItems": 0, 
               "title": "After Message Target Handler Object Id", 
               "type": "string", 
               "description": " The unique identifier of the specific object to send along to the target conversation.", 
               "name": "AfterMessageTargetHandlerObjectId"
          }, 
          "TenantObjectId": {
               "minItems": 0, 
               "title": "Tenant Object Id", 
               "type": "string", 
               "description": " Unique ObjectId of the tbl_Tenant", 
               "name": "TenantObjectId"
          }, 
          "SendUrgentMsg": {
               "minItems": 0, 
               "title": "Send Urgent Msg", 
               "type": "integer", 
               "description": " A flag indicating whether an unidentified caller can mark a message as \"urgent.\"", 
               "name": "SendUrgentMsg"
          }, 
          "Undeletable": {
               "minItems": 0, 
               "title": "Undeletable", 
               "type": "boolean", 
               "description": " A flag indicating whether this handler can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.", 
               "name": "Undeletable"
          }, 
          "VoiceFileURI": {
               "name": "VoiceFileURI", 
               "title": "Voice File URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "AfterMessageTargetConversation": {
               "minItems": 0, 
               "title": "After Message Target Conversation", 
               "type": "string", 
               "description": " The name of the conversation to which the caller is routed.", 
               "name": "AfterMessageTargetConversation"
          }, 
          "InheritSearchSpaceFromCall": {
               "minItems": 0, 
               "title": "Inherit Search Space From Call", 
               "type": "boolean", 
               "description": " A flag indicating whether the call handler inherits the search space from the call or uses the call handler CallSearchSpaceObject. The default value is true ? inherit the search space from the call thereby ignoring the call handler's CallSeachSpaceObjectId.", 
               "name": "InheritSearchSpaceFromCall"
          }, 
          "RecipientContactObjectId": {
               "minItems": 0, 
               "title": "Recipient Contact Object Id", 
               "type": "string", 
               "description": " The recipient for this call handler. If the recipient is a contact, the unique identifier of the Subscriber object where the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL.", 
               "name": "RecipientContactObjectId"
          }, 
          "RecipientDistributionListObjectId": {
               "minItems": 0, 
               "title": "Recipient Distribution List Object Id", 
               "type": "string", 
               "description": " The recipient for this call handler. If the recipient is a distribution list, the unique identifier of the DistributionList object where the recorded message of a call handler should be routed. Otherwise, this attribute is set ot NULL.", 
               "name": "RecipientDistributionListObjectId"
          }, 
          "SendPrivateMsg": {
               "minItems": 0, 
               "title": "Send Private Msg", 
               "type": "integer", 
               "description": " Determines if an outside caller can mark their message as private.", 
               "name": "SendPrivateMsg"
          }, 
          "SendSecureMsg": {
               "minItems": 0, 
               "title": "Send Secure Msg", 
               "type": "boolean", 
               "description": " A flag indicating whether an unidentified caller can mark a message as \"secure.\"", 
               "name": "SendSecureMsg"
          }, 
          "PostGreetingRecordingObjectId": {
               "minItems": 0, 
               "title": "Post Greeting Recording Object Id", 
               "type": "string", 
               "description": " A link to a PostGreetingRecording", 
               "name": "PostGreetingRecordingObjectId"
          }, 
          "UseDefaultLanguage": {
               "minItems": 0, 
               "title": "Use Default Language", 
               "type": "boolean", 
               "description": "A flag indicating whether the language for this call handler is derived from the call handler object attribute or the default language from the location to which the call handler belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.", 
               "name": "UseDefaultLanguage"
          }, 
          "MediaSwitchObjectId": {
               "minItems": 0, 
               "title": "Media Switch Object Id", 
               "type": "string", 
               "description": " Default switch to use for transfers.", 
               "name": "MediaSwitchObjectId"
          }, 
          "LocationURI": {
               "name": "LocationURI", 
               "title": "Location URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }
     }, 
     "schema_version": "14.0"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/UserPrimaryCallHandler/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/UserPrimaryCallHandler device/cuc/UserPrimaryCallHandler schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/UserPrimaryCallHandler/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserPrimaryCallHandler/[pkid1]", "/api/v0/device/cuc/UserPrimaryCallHandler/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/UserPrimaryCallHandler	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/UserPrimaryCallHandler/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/UserPrimaryCallHandler	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/UserPrimaryCallHandler/[pkid1]", "/api/device/cuc/UserPrimaryCallHandler/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserPrimaryCallHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/UserPrimaryCallHandler/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/UserPrimaryCallHandler/[pkid1]", "/api/device/cuc/UserPrimaryCallHandler/[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/cuc/UserPrimaryCallHandler and the JSON format can be used to import instances of device/cuc/UserPrimaryCallHandler.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/cuc/UserPrimaryCallHandler:

 GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserPrimaryCallHandler	POST	/api/device/cuc/UserPrimaryCallHandler/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cuc/UserPrimaryCallHandler	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/UserPrimaryCallHandler/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/UserPrimaryCallHandler/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/cuc/UserPrimaryCallHandler/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/UserPrimaryCallHandler schema and all instances as JSON.

(The list will return 0 to 3 device/cuc/UserPrimaryCallHandler instances)

GET http://[host]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/UserPrimaryCallHandler/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "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": [
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/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/cuc/UserPrimaryCallHandler", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/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/cuc/UserPrimaryCallHandler/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/UserPrimaryCallHandler/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/UserPrimaryCallHandler", 
          "model_specific_actions": [
               "list", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "DisplayName", 
                    "title": "Display Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/UserPrimaryCallHandler.	GET	/api/device/cuc/UserPrimaryCallHandler/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/UserPrimaryCallHandler as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/UserPrimaryCallHandler/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cuc/UserPrimaryCallHandler

GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/UserPrimaryCallHandler	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/cuc/UserPrimaryCallHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/UserPrimaryCallHandler/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/cuc/UserPrimaryCallHandler and the JSON format can be used to import instances of device/cuc/UserPrimaryCallHandler.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Help	GET	/api/device/cuc/UserPrimaryCallHandler/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/cuc/UserPrimaryCallHandler.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cuc/UserPrimaryCallHandler/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/cuc/UserPrimaryCallHandler

GET http://[host-proxy]/api/device/cuc/UserPrimaryCallHandler/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cuc/UserPrimaryCallHandler/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Clone

Move

Export

Help

Purge