API Reference for device/cuc/Contact

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/Contact/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"
          }, 
          "DtmfNameLastFirst": {
               "minItems": 0, 
               "title": "Dtmf Name Last First", 
               "type": "string", 
               "description": " Digits corresponding the numeric keypad mapping on a standard touchtone phone representing the last name followed by the first name of the contact. These digits are used for searching the contact by name via the phone.", 
               "name": "DtmfNameLastFirst"
          }, 
          "DisplayName": {
               "minItems": 0, 
               "title": "Display Name", 
               "type": "string", 
               "description": " The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.", 
               "name": "DisplayName"
          }, 
          "FirstName": {
               "minItems": 0, 
               "title": "First Name", 
               "type": "string", 
               "description": " The first name (i.e., givenName) of a contact. Not their surname nor middle name.", 
               "name": "FirstName"
          }, 
          "LastName": {
               "minItems": 0, 
               "title": "Last Name", 
               "type": "string", 
               "description": " The last name (i.e., surname or family name) of a contact, by which a contact is commonly known.", 
               "name": "LastName"
          }, 
          "DtmfNameFirstLast": {
               "minItems": 0, 
               "title": "Dtmf Name First Last", 
               "type": "string", 
               "description": " Digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name followed by the last name of the contact. These digits are used for searching the contact by name via the phone.", 
               "name": "DtmfNameFirstLast"
          }, 
          "IsAddressable": {
               "minItems": 0, 
               "title": "Is Addressable", 
               "type": "boolean", 
               "description": " A flag indicating whether the entity to which the alias belongs is addressable. By default all distribution lists are addressable. All subscribers (users with a voice mailbox, except UnityCinnection Messaging System user) are addressable. All contacts that are associated with a delivery location are addressable.", 
               "name": "IsAddressable"
          }, 
          "CallHandlerObjectId": {
               "minItems": 0, 
               "title": "Call Handler Object Id", 
               "type": "string", 
               "description": " The unique identifier of the primary CallHandler object for the contact.", 
               "name": "CallHandlerObjectId"
          }, 
          "DeliveryLocationPartitionObjectId": {
               "minItems": 0, 
               "title": "Delivery Location Partition Object Id", 
               "type": "string", 
               "description": "The partition assigned to the delivery location. The unique identifier of the Partition to which the DtmfAccessId is assigned.", 
               "name": "DeliveryLocationPartitionObjectId"
          }, 
          "TransferEnabled": {
               "minItems": 0, 
               "title": "Transfer Enabled", 
               "type": "boolean", 
               "description": "Transfer enabled? A flag indicating whether or not a call handler has Transfer Enabled.", 
               "name": "TransferEnabled"
          }, 
          "PartitionURI": {
               "name": "PartitionURI", 
               "title": "Partition URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "AltLastName": {
               "minItems": 0, 
               "title": "Alt Last Name", 
               "type": "string", 
               "description": " Alternate spelling of a contact's last name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.", 
               "name": "AltLastName"
          }, 
          "PartitionObjectId": {
               "minItems": 0, 
               "title": "Partition Object Id", 
               "type": "string", 
               "description": " The unique identifier of the Partition to which the Contact is assigned.", 
               "name": "PartitionObjectId"
          }, 
          "DeliveryLocationDtmfAccessId": {
               "minItems": 0, 
               "title": "Delivery Location Dtmf Access Id", 
               "type": "string", 
               "description": "The dtmf access id for the location to which this object belongs. The dialable number.", 
               "name": "DeliveryLocationDtmfAccessId"
          }, 
          "TransferRings": {
               "minItems": 0, 
               "title": "Transfer Rings", 
               "type": "integer", 
               "description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.", 
               "name": "TransferRings"
          }, 
          "TransferExtension": {
               "minItems": 0, 
               "title": "Transfer Extension", 
               "type": "string", 
               "description": " The extension (phone number) to transfer to", 
               "name": "TransferExtension"
          }, 
          "DeliveryLocationURI": {
               "name": "DeliveryLocationURI", 
               "title": "Delivery Location URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "VoiceNameURI": {
               "name": "VoiceNameURI", 
               "title": "Voice Name URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "LocationObjectId": {
               "minItems": 0, 
               "title": "Location Object Id", 
               "type": "string", 
               "description": " The unique identifier of the LocationVMS object to which this contact belongs.", 
               "name": "LocationObjectId"
          }, 
          "ContactType": {
               "minItems": 0, 
               "title": "Contact Type", 
               "type": "integer", 
               "description": "Identifies the type of contact based on the DeliveryLocationObjectId.", 
               "name": "ContactType"
          }, 
          "DeliveryLocationObjectId": {
               "minItems": 0, 
               "title": "Delivery Location Object Id", 
               "type": "string", 
               "description": " The unique identifier of the location to which this contact's messages will be sent.  Currently, this is a LocationVPIM, but in the future as we add other types of interops it could be another type of Location such as LocationOctel or LocationAMIS.", 
               "name": "DeliveryLocationObjectId"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a Contact object. - template parameter [1]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "RemoteAddress": {
               "minItems": 0, 
               "title": "Remote Address", 
               "type": "string", 
               "description": " A mail address on the remote system.", 
               "name": "RemoteAddress"
          }, 
          "CallhandlerURI": {
               "name": "CallhandlerURI", 
               "title": "Callhandler 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 instance of a Contact object is a \"template\" for creating contacts.", 
               "name": "IsTemplate"
          }, 
          "URI": {
               "name": "URI", 
               "title": "URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "Alias": {
               "minItems": 0, 
               "title": "Alias", 
               "type": "string", 
               "description": " The unique text name for either a user, distribution list, or personal group.", 
               "name": "Alias"
          }, 
          "DisableOutbound": {
               "minItems": 0, 
               "title": "Disable Outbound", 
               "type": "boolean", 
               "description": " For an AMIS remote contact, indicates no messages are being delivered to this target", 
               "name": "DisableOutbound"
          }, 
          "AlternateNamesURI": {
               "title": "Alternate Names URI", 
               "type": "string", 
               "description": "The URI to get the alternate names of the contact.", 
               "name": "AlternateNamesURI"
          }, 
          "VoiceFileURI": {
               "name": "VoiceFileURI", 
               "title": "Voice File URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "TransferType": {
               "minItems": 0, 
               "title": "Transfer Type", 
               "type": "integer", 
               "description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).", 
               "name": "TransferType"
          }, 
          "AutoCreateCallHandler": {
               "minItems": 0, 
               "title": "Auto Create Call Handler", 
               "type": "boolean", 
               "description": " A flag indicating whether or not a call handler should be automatically created for a contact.", 
               "name": "AutoCreateCallHandler"
          }, 
          "AltFirstName": {
               "minItems": 0, 
               "title": "Alt First Name", 
               "type": "string", 
               "description": " Alternate spelling of a contact's first name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.", 
               "name": "AltFirstName"
          }, 
          "DeliveryLocationPartitionURI": {
               "name": "DeliveryLocationPartitionURI", 
               "title": "Delivery Location Partition URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "templateAlias": {
               "description": "Query parameter", 
               "name": "templateAlias", 
               "format": "uri", 
               "title": "Template Alias", 
               "required": false, 
               "choices": [], 
               "target_attr": "Alias", 
               "target_model_type": "device/cuc/UserTemplate", 
               "type": [
                    "string"
               ], 
               "target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "DtmfAccessId": {
               "minItems": 0, 
               "title": "Dtmf Access Id", 
               "type": "string", 
               "description": " This column shadows the object's optional dtmfaccessid from tbl_DtmfAccessId. It was added to speed up queries.", 
               "name": "DtmfAccessId"
          }, 
          "ListInDirectory": {
               "minItems": 0, 
               "title": "List In Directory", 
               "type": "boolean", 
               "description": " A flag indicating whether Cisco Unity Connection should list the contact in the phone directory for outside callers.", 
               "name": "ListInDirectory"
          }, 
          "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": "12.5"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/cuc/Contact/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/cuc/Contact 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/cuc/Contact/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/cuc/Contact/	hierarchy=[hierarchy]	{"hrefs":["/api/device/cuc/Contact/[pkid1]", "/api/device/cuc/Contact/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/cuc/Contact
```
GET http://[host-proxy]/api/device/cuc/Contact/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/Contact/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/Contact device/cuc/Contact schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/Contact/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Contact/[pkid1]", "/api/v0/device/cuc/Contact/[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/Contact/?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/Contact	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/Contact/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/Contact	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/Contact/[pkid1]", "/api/device/cuc/Contact/[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/Contact/?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/Contact; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/Contact/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/Contact/[pkid1]", "/api/device/cuc/Contact/[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/Contact and the JSON format can be used to import instances of device/cuc/Contact.

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

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

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/Contact/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/Contact/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/Contact/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/Contact schema and all instances as JSON.

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

GET http://[host]/api/device/cuc/Contact/?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/Contact/?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": "12.5", 
          "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/cuc/Contact/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/cuc/Contact/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/Contact/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/Contact", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/Contact/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/Contact/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/Contact/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/Contact/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/Contact/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/Contact/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/Contact/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/Contact", 
          "model_specific_actions": [
               "add", 
               "list", 
               "update", 
               "get", 
               "remove", 
               "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": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/Contact.	GET	/api/device/cuc/Contact/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/Contact 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	Payload
Modify	PUT	/api/device/cuc/Contact/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/cuc/Contact/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/Contact/[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/Contact

GET http://[host-proxy]/api/device/cuc/Contact/?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/Contact	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/Contact; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/Contact/[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/Contact and the JSON format can be used to import instances of device/cuc/Contact.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/Contact/[pkid]/	hierarchy=[hierarchy]	The device/cuc/Contact instance with [pkid].

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

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

API Reference for device/cuc/Contact

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

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge