[Index]
Model ref.: device/cuc/PhoneNumber
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": {
"PartitionObjectId": {
"minItems": 0,
"title": "Partition Object Id",
"type": "string",
"description": " The unique identifier of the Partition to which the PhoneNumber is assigned.",
"name": "PartitionObjectId"
},
"PartitionURI": {
"minItems": 0,
"title": "Partition URI",
"type": "string",
"name": "PartitionURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"OwnerContactObjectId": {
"minItems": 0,
"title": "Owner Contact Object Id",
"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"
},
"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,
"title": "Is Primary Fax",
"type": "boolean",
"description": " A flag indicating whether this instance of a PhoneNumber is the primary Fax number.",
"name": "IsPrimaryFax"
},
"CallPickupTimeout": {
"minItems": 0,
"title": "Call Pickup Timeout",
"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"
},
"SearchablePhoneNumber": {
"minItems": 0,
"title": "Searchable Phone Number",
"type": "string",
"description": " Phone number without formatting or any dial codes. A basic form suitable for searching on.",
"name": "SearchablePhoneNumber"
},
"OwnerContactURI": {
"minItems": 0,
"title": "Owner Contact URI",
"type": "string",
"name": "OwnerContactURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"OwnerGlobalUserURI": {
"minItems": 0,
"title": "Owner Global User URI",
"type": "string",
"name": "OwnerGlobalUserURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"DialablePhoneNumber": {
"minItems": 0,
"title": "Dialable Phone Number",
"type": "string",
"description": " A dialable version of the PhoneNumber column.",
"name": "DialablePhoneNumber"
},
"PhoneNumber": {
"minItems": 0,
"title": "Phone Number",
"type": "string",
"description": " A phone number.",
"name": "PhoneNumber"
},
"PhoneType": {
"minItems": 0,
"title": "Phone Type",
"type": "integer",
"description": " A well-defined name for the phone number, such as \"Home,\" \"Business,\" \"Mobile,\" etc.",
"name": "PhoneType"
},
"OwnerUserURI": {
"minItems": 0,
"title": "Owner User URI",
"type": "string",
"name": "OwnerUserURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"ClientMatterCode": {
"minItems": 0,
"title": "Client Matter Code",
"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"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"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"
},
"OwnerUserObjectId": {
"minItems": 0,
"title": "Owner User Object Id",
"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"
},
"OwnerGlobalUserObjectId": {
"minItems": 0,
"title": "Owner Global User Object Id",
"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"
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"title": "Transmit Forced Authorization Code",
"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"
},
"AutoLogon": {
"minItems": 0,
"title": "Auto Logon",
"type": "boolean",
"description": " A flag indicating whether the phone number can be used for automatically logging on the caller.",
"name": "AutoLogon"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/PhoneNumber/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/PhoneNumber/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PhoneNumber/[pkid1]", "/api/v0/device/cuc/PhoneNumber/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PhoneNumber/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/PhoneNumber |
|
{"hrefs": ["/api/device/cuc/PhoneNumber/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PhoneNumber |
|
{"hrefs": ["/api/device/cuc/PhoneNumber/[pkid1]", "/api/device/cuc/PhoneNumber/[pkid2]",...]} |
| 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/ |
|
{ "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.
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/ |
|
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 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 http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/PhoneNumber/ |
|
The device/cuc/PhoneNumber schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PhoneNumber instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 51,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/cuc/PhoneNumber/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/PhoneNumber",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/PhoneNumber/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/PhoneNumber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/PhoneNumber/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/PhoneNumber/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/PhoneNumber/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/PhoneNumber/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/PhoneNumber/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/PhoneNumber/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/PhoneNumber/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"PartitionObjectId": "03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"PartitionURI": "/vmrest/partitions/03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"ObjectId": "81f5af7f-b162-4d08-831d-bd03b29a62cd",
"IsPrimaryFax": false,
"CallPickupTimeout": 0,
"SearchablePhoneNumber": "33561935501",
"URI": "/vmrest/phonenumbers/81f5af7f-b162-4d08-831d-bd03b29a62cd",
"OwnerGlobalUserURI": "/vmrest/globalusers/e182f804-9ea0-4862-9757-963e2e09ea3c",
"PhoneNumber": "+33561935501",
"PhoneType": 34,
"OwnerUserURI": "/vmrest/users/e182f804-9ea0-4862-9757-963e2e09ea3c",
"OwnerUserObjectId": "e182f804-9ea0-4862-9757-963e2e09ea3c",
"OwnerGlobalUserObjectId": "e182f804-9ea0-4862-9757-963e2e09ea3c",
"TransmitForcedAuthorizationCode": false,
"AutoLogon": false,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/PhoneNumber",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/",
"pkid": "6049a9dece894e001407bce1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6049a9dece894e001407bce1"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6049a9dece894e001407bce1/?model_type=device/cuc/PhoneNumber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6049a9dece894e001407bce1"
},
{
"data": {
"PartitionObjectId": "03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"PartitionURI": "/vmrest/partitions/03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"ObjectId": "b7f92610-1cc8-485d-bd55-1609430bf96b",
"IsPrimaryFax": false,
"hierarchy": "5ae89ea2affa931cce38a523",
"CallPickupTimeout": 0,
"SearchablePhoneNumber": "444074371101",
"URI": "/vmrest/phonenumbers/b7f92610-1cc8-485d-bd55-1609430bf96b",
"OwnerGlobalUserURI": "/vmrest/globalusers/5200b27e-efea-4c1c-a38e-060f7d0ca851",
"PhoneNumber": "+444074371101",
"PhoneType": 34,
"OwnerUserURI": "/vmrest/users/5200b27e-efea-4c1c-a38e-060f7d0ca851",
"OwnerUserObjectId": "5200b27e-efea-4c1c-a38e-060f7d0ca851",
"OwnerGlobalUserObjectId": "5200b27e-efea-4c1c-a38e-060f7d0ca851",
"TransmitForcedAuthorizationCode": false,
"AutoLogon": false,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/PhoneNumber",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/",
"pkid": "6049a9dece894e001407bce3"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6049a9dece894e001407bce3"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6049a9dece894e001407bce3/?model_type=device/cuc/PhoneNumber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce3/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6049a9dece894e001407bce3"
},
{
"data": {
"PartitionObjectId": "03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"PartitionURI": "/vmrest/partitions/03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"ObjectId": "e709c3db-50a3-4c65-b91c-ed9f813e32b3",
"IsPrimaryFax": false,
"hierarchy": "5ae89ea2affa931cce38a523",
"CallPickupTimeout": 0,
"SearchablePhoneNumber": "33561935510",
"URI": "/vmrest/phonenumbers/e709c3db-50a3-4c65-b91c-ed9f813e32b3",
"OwnerGlobalUserURI": "/vmrest/globalusers/abb8c747-e997-4044-a27d-ab2b5817e2d8",
"PhoneNumber": "+33561935510",
"PhoneType": 34,
"OwnerUserURI": "/vmrest/users/abb8c747-e997-4044-a27d-ab2b5817e2d8",
"OwnerUserObjectId": "abb8c747-e997-4044-a27d-ab2b5817e2d8",
"OwnerGlobalUserObjectId": "abb8c747-e997-4044-a27d-ab2b5817e2d8",
"TransmitForcedAuthorizationCode": false,
"AutoLogon": false,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/PhoneNumber",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/",
"pkid": "6049a9dece894e001407bce5"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6049a9dece894e001407bce5"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6049a9dece894e001407bce5/?model_type=device/cuc/PhoneNumber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce5/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6049a9dece894e001407bce5"
}
]
}
(Show the first instance)
{
"data": {
"PartitionObjectId": "03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"PartitionURI": "/vmrest/partitions/03b53b24-d728-4b46-ba7a-6a5c46d1e046",
"ObjectId": "81f5af7f-b162-4d08-831d-bd03b29a62cd",
"IsPrimaryFax": false,
"OwnerGlobalUserObjectId": "e182f804-9ea0-4862-9757-963e2e09ea3c",
"AutoLogon": false,
"URI": "/vmrest/phonenumbers/81f5af7f-b162-4d08-831d-bd03b29a62cd",
"PhoneNumber": "+33561935501",
"PhoneType": 34,
"OwnerUserURI": "/vmrest/users/e182f804-9ea0-4862-9757-963e2e09ea3c",
"TransmitForcedAuthorizationCode": false,
"OwnerUserObjectId": "e182f804-9ea0-4862-9757-963e2e09ea3c",
"CallPickupTimeout": 0,
"SearchablePhoneNumber": "33561935501",
"OwnerGlobalUserURI": "/vmrest/globalusers/e182f804-9ea0-4862-9757-963e2e09ea3c"
},
"meta": {
"model_type": "device/cuc/PhoneNumber",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/",
"pkid": "6049a9dece894e001407bce1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6049a9dece894e001407bce1"
],
"schema_version": "11.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6049a9dece894e001407bce1/?hierarchy=[hierarchy]&model_type=device/cuc/PhoneNumber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/PhoneNumber/6049a9dece894e001407bce1/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "6049a9dece894e001407bce1"
}
| 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 |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/PhoneNumber/purge/ |
|
| 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 |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PhoneNumber/?hierarchy=[hierarchy]&format=json
| 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 |
|
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: |