API Reference for device/cuc/PhoneNumber

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/PhoneNumber/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "PartitionObjectId": {
               "minItems": 0, 
               "type": "string", 
               "description": " The unique identifier of the Partition to which the PhoneNumber is assigned.", 
               "name": "PartitionObjectId", 
               "title": "Partition Object Id"
          }, 
          "PartitionURI": {
               "name": "PartitionURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Partition URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "OwnerContactObjectId": {
               "minItems": 0, 
               "type": "string", 
               "description": " The object to which this phone number belongs. If the phone number belongs to a Contact, the unique identifier of the Contact object to which this phone number belongs. Otherwise, this attribute is set to NULL.", 
               "name": "OwnerContactObjectId", 
               "title": "Owner Contact Object Id"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a PhoneNumber object. - template parameter [1]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "IsPrimaryFax": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether this instance of a PhoneNumber is the primary Fax number.", 
               "name": "IsPrimaryFax", 
               "title": "Is Primary Fax"
          }, 
          "OwnerGlobalUserObjectId": {
               "minItems": 0, 
               "type": "string", 
               "description": " The object to which this phone number belongs. If the phone number belongs to a User, the unique identifier of the User object to which this phone number belongs. Otherwise, this attribute is set to NULL.", 
               "name": "OwnerGlobalUserObjectId", 
               "title": "Owner Global User Object Id"
          }, 
          "AutoLogon": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether the phone number can be used for automatically logging on the caller.", 
               "name": "AutoLogon", 
               "title": "Auto Logon"
          }, 
          "OwnerContactURI": {
               "name": "OwnerContactURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Owner Contact URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "URI": {
               "name": "URI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "DisplayName": {
               "minItems": 0, 
               "type": "string", 
               "description": " The preferred text name of the phone number to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. ", 
               "name": "DisplayName", 
               "title": "Display Name"
          }, 
          "DialablePhoneNumber": {
               "minItems": 0, 
               "type": "string", 
               "description": " A dialable version of the PhoneNumber column.", 
               "name": "DialablePhoneNumber", 
               "title": "Dialable Phone Number"
          }, 
          "PhoneNumber": {
               "minItems": 0, 
               "type": "string", 
               "description": " A phone number.", 
               "name": "PhoneNumber", 
               "title": "Phone Number"
          }, 
          "PhoneType": {
               "minItems": 0, 
               "type": "integer", 
               "description": " A well-defined name for the phone number, such as \"Home,\" \"Business,\" \"Mobile,\" etc.", 
               "name": "PhoneType", 
               "title": "Phone Type"
          }, 
          "OwnerUserURI": {
               "name": "OwnerUserURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Owner User URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "TransmitForcedAuthorizationCode": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether an authorization code should be transmitted to Call Manager after this number is dialed during an outbound call.", 
               "name": "TransmitForcedAuthorizationCode", 
               "title": "Transmit Forced Authorization Code"
          }, 
          "ClientMatterCode": {
               "minItems": 0, 
               "type": "string", 
               "description": " The client matter code to transmit to Call Manger when the phone number is dialed on an outbound call.  The CMC is entered after a phone number is dialed so that the customer can assigning account or billing codes to the call.", 
               "name": "ClientMatterCode", 
               "title": "Client Matter Code"
          }, 
          "OwnerUserObjectId": {
               "minItems": 0, 
               "type": "string", 
               "description": " The object to which this phone number belongs. If the phone number belongs to a User, the unique identifier of the User object to which this phone number belongs. Otherwise, this attribute is set to NULL.", 
               "name": "OwnerUserObjectId", 
               "title": "Owner User Object Id"
          }, 
          "CallPickupTimeout": {
               "minItems": 0, 
               "type": "integer", 
               "description": " The number of rings that Cisco Unity Connection will wait for a subscriber destination to answer before the call is forwarded to the next destination in the destination group.", 
               "name": "CallPickupTimeout", 
               "title": "Call Pickup Timeout"
          }, 
          "SearchablePhoneNumber": {
               "minItems": 0, 
               "type": "string", 
               "description": " Phone number without formatting or any dial codes. A basic form suitable for searching on.", 
               "name": "SearchablePhoneNumber", 
               "title": "Searchable Phone Number"
          }, 
          "OwnerGlobalUserURI": {
               "name": "OwnerGlobalUserURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Owner Global User URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }
     }, 
     "schema_version": "12.5"
}

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

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

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

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

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

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

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

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

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/PhoneNumber.	GET	/api/device/cuc/PhoneNumber/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/PhoneNumber 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/PhoneNumber/[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/PhoneNumber

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

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for device/cuc/PhoneNumber

GET http://[host-proxy]/api/device/cuc/PhoneNumber/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/PhoneNumber/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Clone

Move

Export

Get

Help

Purge