[Index]
Model ref.: device/cuc/PhoneSystemAssociation
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": {
"numNotificationDevice": {
"minItems": 0,
"title": "Num Notification Device",
"type": "integer",
"description": "Number of notification devices.",
"name": "numNotificationDevice"
},
"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"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a User object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"numNotificationMWI": {
"minItems": 0,
"title": "Num Notification MWI",
"type": "integer",
"description": "Number of MWI devices.",
"name": "numNotificationMWI"
},
"MediaSwitchDisplayName": {
"minItems": 0,
"title": "Media Switch Display Name",
"type": "string",
"description": " The unique text name (e.g., \"Unified Communications Manager Cluster - Seattle\") of the media switch to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "MediaSwitchDisplayName"
},
"numPrimaryCallHandler": {
"minItems": 0,
"title": "Num Primary Call Handler",
"type": "integer",
"description": "Number of primary call handlers.",
"name": "numPrimaryCallHandler"
},
"MediaSwitchObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MediaSwitch object. - template parameter [1]",
"name": "MediaSwitchObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/PhoneSystem",
"title": "Media Switch Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/PhoneSystemAssociation/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/PhoneSystemAssociation/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PhoneSystemAssociation/[pkid1]", "/api/v0/device/cuc/PhoneSystemAssociation/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PhoneSystemAssociation/?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/PhoneSystemAssociation |
|
{"hrefs": ["/api/device/cuc/PhoneSystemAssociation/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PhoneSystemAssociation |
|
{"hrefs": ["/api/device/cuc/PhoneSystemAssociation/[pkid1]", "/api/device/cuc/PhoneSystemAssociation/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/PhoneSystemAssociation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/PhoneSystemAssociation/export/ |
|
{ "hrefs":["/api/device/cuc/PhoneSystemAssociation/[pkid1]", "/api/device/cuc/PhoneSystemAssociation/[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/PhoneSystemAssociation and the JSON format can be used to import instances of device/cuc/PhoneSystemAssociation.
GET http://[host-proxy]/api/device/cuc/PhoneSystemAssociation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/PhoneSystemAssociation | POST | /api/device/cuc/PhoneSystemAssociation/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/PhoneSystemAssociation/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/PhoneSystemAssociation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/PhoneSystemAssociation/ |
|
The device/cuc/PhoneSystemAssociation schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PhoneSystemAssociation instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/PhoneSystemAssociation/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 23
},
"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/PhoneSystemAssociation/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/PhoneSystemAssociation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PhoneSystemAssociation/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/PhoneSystemAssociation/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/PhoneSystemAssociation/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/PhoneSystemAssociation/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/PhoneSystemAssociation/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PhoneSystemAssociation/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PhoneSystemAssociation/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PhoneSystemAssociation",
"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"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "63057ba2c46e74b468824f18",
"meta": {
"tags": [],
"cached": true,
"title": "Adam Pjones",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057ba2c46e74b468824f18",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057ba2c46e74b468824f18/?model_type=device/cuc/PhoneSystemAssociation",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PhoneSystemAssociation",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057ba2c46e74b468824f18"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numNotificationDevice": 4,
"DisplayName": "Adam Pjones",
"ObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy": "6305775dc46e74b46881c66a",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"URI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04/phonesystemassociations/533a6851-0472-4a2c-b644-8a4cd2187a14",
"Alias": "Jones",
"numNotificationMWI": 1,
"MediaSwitchDisplayName": "PhoneSystem",
"hierarchy_friendly_name": "Overton (Customer)",
"numPrimaryCallHandler": 1,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "63057ba2c46e74b468824f20",
"meta": {
"tags": [],
"cached": true,
"title": "Don Rich",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057ba2c46e74b468824f20",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057ba2c46e74b468824f20/?model_type=device/cuc/PhoneSystemAssociation",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f20/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/PhoneSystemAssociation",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057ba2c46e74b468824f20"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numNotificationDevice": 4,
"DisplayName": "Don Rich",
"ObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy": "6305775dc46e74b46881c66a",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"URI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04/phonesystemassociations/db83873f-bb81-4529-b901-46e8c6318f0f",
"Alias": "drich01",
"numNotificationMWI": 1,
"MediaSwitchDisplayName": "PhoneSystem",
"hierarchy_friendly_name": "Overton (Customer)",
"numPrimaryCallHandler": 1,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "63057ba2c46e74b468824f1c",
"meta": {
"tags": [],
"cached": true,
"title": "jones, Vjones",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057ba2c46e74b468824f1c",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/63057ba2c46e74b468824f1c/?model_type=device/cuc/PhoneSystemAssociation",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f1c/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PhoneSystemAssociation",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057ba2c46e74b468824f1c"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numNotificationDevice": 4,
"DisplayName": "jones, Vjones",
"ObjectId": "c3b26278-518b-4f1c-b236-e2b5ef871238",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy": "6305775dc46e74b46881c66a",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"URI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04/phonesystemassociations/c3b26278-518b-4f1c-b236-e2b5ef871238",
"Alias": "Pjones",
"numNotificationMWI": 1,
"MediaSwitchDisplayName": "PhoneSystem",
"hierarchy_friendly_name": "Overton (Customer)",
"numPrimaryCallHandler": 1,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "63057ba2c46e74b468824f18",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Adam Pjones",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"self": [
{
"pkid": "63057ba2c46e74b468824f18",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057ba2c46e74b468824f18/?hierarchy=[hierarchy]&model_type=device/cuc/PhoneSystemAssociation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PhoneSystemAssociation/63057ba2c46e74b468824f18/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PhoneSystemAssociation",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057ba2c46e74b468824f18"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numNotificationDevice": 4,
"DisplayName": "Adam Pjones",
"ObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"Alias": "Jones",
"URI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04/phonesystemassociations/533a6851-0472-4a2c-b644-8a4cd2187a14",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"numNotificationMWI": 1,
"MediaSwitchDisplayName": "PhoneSystem",
"numPrimaryCallHandler": 1,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/PhoneSystemAssociation. | GET | /api/device/cuc/PhoneSystemAssociation/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/PhoneSystemAssociation as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/PhoneSystemAssociation/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PhoneSystemAssociation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/PhoneSystemAssociation | 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/PhoneSystemAssociation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/PhoneSystemAssociation/[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/PhoneSystemAssociation and the JSON format can be used to import instances of device/cuc/PhoneSystemAssociation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/PhoneSystemAssociation/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/PhoneSystemAssociation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/PhoneSystemAssociation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/PhoneSystemAssociation. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/PhoneSystemAssociation/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |