[Index]
Model ref.: device/cuc/DtmfAccessId
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": {
"ParentSubscriberObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Subscriber object to which this DtmfAccessId belongs",
"name": "ParentSubscriberObjectId",
"title": "Parent Subscriber Object Id"
},
"ParentGlobalUserObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Subscriber object to which this DtmfAccessId belongs",
"name": "ParentGlobalUserObjectId",
"title": "Parent Global User Object Id"
},
"ParentLocationURI": {
"name": "ParentLocationURI",
"format": "uri",
"minItems": 0,
"title": "Parent Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ParentDistributionListObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the DistributionList object to which this DtmfAccessId belongs",
"name": "ParentDistributionListObjectId",
"title": "Parent Distribution List Object Id"
},
"UserDefined": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this DtmfAccessId was created by the end-user. The default setting is false.",
"name": "UserDefined",
"title": "User Defined"
},
"ParentLocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Location object to which this DtmfAccessId belongs,",
"name": "ParentLocationObjectId",
"title": "Parent Location 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]
},
"PartitionObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Partition to which the DtmfAccessId is assigned.",
"name": "PartitionObjectId",
"title": "Partition Object Id"
},
"ParentUserURI": {
"name": "ParentUserURI",
"format": "uri",
"minItems": 0,
"title": "Parent User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IdIndex": {
"minItems": 0,
"type": "integer",
"description": " An index into the alternate extensions for a subscriber.",
"name": "IdIndex",
"title": "Id Index"
},
"ParentContactObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Contact object to which this DtmfAccessId belongs.",
"name": "ParentContactObjectId",
"title": "Parent Contact Object Id"
},
"LocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Location object to which this location (denormalized) belongs.",
"name": "LocationObjectId",
"title": "Location Object Id"
},
"ParentGlobalUserURI": {
"name": "ParentGlobalUserURI",
"format": "uri",
"minItems": 0,
"title": "Parent Global User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ParentContactURI": {
"name": "ParentContactURI",
"format": "uri",
"minItems": 0,
"title": "Parent Contact URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DtmfAccessId object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ClientMatterCode": {
"minItems": 0,
"type": "string",
"description": " The Client Matter Code (CMS) 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 assign account or billing codes to the call.",
"name": "ClientMatterCode",
"title": "Client Matter Code"
},
"ParentHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Handler object to which this DtmfAccessId belongs",
"name": "ParentHandlerObjectId",
"title": "Parent Handler Object Id"
},
"DtmfAccessId": {
"minItems": 0,
"type": "string",
"description": " The dialable number.",
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The text name of this DtmfAccessId to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"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"
},
"ParentDistributionListURI": {
"name": "ParentDistributionListURI",
"format": "uri",
"minItems": 0,
"title": "Parent Distribution List URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/DtmfAccessId/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/DtmfAccessId/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/DtmfAccessId/[pkid1]", "/api/v0/device/cuc/DtmfAccessId/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/DtmfAccessId/?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/DtmfAccessId |
|
{"hrefs": ["/api/device/cuc/DtmfAccessId/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/DtmfAccessId |
|
{"hrefs": ["/api/device/cuc/DtmfAccessId/[pkid1]", "/api/device/cuc/DtmfAccessId/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/DtmfAccessId; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/DtmfAccessId/export/ |
|
{ "hrefs":["/api/device/cuc/DtmfAccessId/[pkid1]", "/api/device/cuc/DtmfAccessId/[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/DtmfAccessId and the JSON format can be used to import instances of device/cuc/DtmfAccessId.
GET http://[host-proxy]/api/device/cuc/DtmfAccessId/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/DtmfAccessId | POST | /api/device/cuc/DtmfAccessId/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/DtmfAccessId/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/DtmfAccessId/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/DtmfAccessId/ |
|
The device/cuc/DtmfAccessId schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/DtmfAccessId instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/DtmfAccessId/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 18
},
"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/DtmfAccessId/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/DtmfAccessId",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DtmfAccessId/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/DtmfAccessId/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/DtmfAccessId/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/DtmfAccessId/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/DtmfAccessId/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DtmfAccessId/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DtmfAccessId/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DtmfAccessId",
"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": "5f3ae6dbce894e0012058fc6",
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6dbce894e0012058fc6",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6dbce894e0012058fc6/?model_type=device/cuc/DtmfAccessId",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DtmfAccessId",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6dbce894e0012058fc6"
],
"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": {
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"ParentDistributionListObjectId": "074b7d87-d59e-4a18-acd6-23be0aa73d08",
"IdIndex": 0,
"UserDefined": false,
"CallPickupTimeout": 4,
"URI": "/vmrest/dtmfaccessids/6cf4f68f-a3f1-4aeb-afa9-d9bc1118c71e",
"DtmfAccessId": "99991",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ParentDistributionListURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"ObjectId": "6cf4f68f-a3f1-4aeb-afa9-d9bc1118c71e",
"TransmitForcedAuthorizationCode": false,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae6dcce894e0012058fcc",
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae6dcce894e0012058fcc",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6dcce894e0012058fcc/?model_type=device/cuc/DtmfAccessId",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fcc/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/DtmfAccessId",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6dcce894e0012058fcc"
],
"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": {
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"ParentDistributionListObjectId": "73bf027a-1975-44f3-9311-9fa534d8ddfa",
"IdIndex": 0,
"UserDefined": false,
"hierarchy": "5f3ae552ce894e00120537fa",
"CallPickupTimeout": 4,
"URI": "/vmrest/dtmfaccessids/c3fbc0ce-9d51-4cb8-bada-c051944e6a62",
"DtmfAccessId": "99992",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ParentDistributionListURI": "/vmrest/distributionlists/73bf027a-1975-44f3-9311-9fa534d8ddfa",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"ObjectId": "c3fbc0ce-9d51-4cb8-bada-c051944e6a62",
"TransmitForcedAuthorizationCode": false,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae6dcce894e0012058fe3",
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae6dcce894e0012058fe3",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5f3ae6dcce894e0012058fe3/?model_type=device/cuc/DtmfAccessId",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dcce894e0012058fe3/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DtmfAccessId",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6dcce894e0012058fe3"
],
"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": {
"ParentSubscriberObjectId": "876e199f-5098-4f0f-a86a-d02de83e24fe",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"ParentGlobalUserObjectId": "876e199f-5098-4f0f-a86a-d02de83e24fe",
"ParentUserURI": "/vmrest/users/876e199f-5098-4f0f-a86a-d02de83e24fe",
"ObjectId": "1a0c8b57-0756-4c2d-9acb-056f019f2120",
"IdIndex": 0,
"UserDefined": false,
"hierarchy": "5f3ae552ce894e00120537fa",
"URI": "/vmrest/dtmfaccessids/1a0c8b57-0756-4c2d-9acb-056f019f2120",
"DtmfAccessId": "99999",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"ParentGlobalUserURI": "/vmrest/globalusers/876e199f-5098-4f0f-a86a-d02de83e24fe",
"hierarchy_friendly_name": "AB_Group (Customer)",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"CallPickupTimeout": 4,
"TransmitForcedAuthorizationCode": false,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6dbce894e0012058fc6",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6dbce894e0012058fc6",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6dbce894e0012058fc6/?hierarchy=[hierarchy]&model_type=device/cuc/DtmfAccessId",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DtmfAccessId/5f3ae6dbce894e0012058fc6/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DtmfAccessId",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6dbce894e0012058fc6"
],
"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": {
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"ParentDistributionListObjectId": "074b7d87-d59e-4a18-acd6-23be0aa73d08",
"IdIndex": 0,
"UserDefined": false,
"URI": "/vmrest/dtmfaccessids/6cf4f68f-a3f1-4aeb-afa9-d9bc1118c71e",
"DtmfAccessId": "99991",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"TransmitForcedAuthorizationCode": false,
"ObjectId": "6cf4f68f-a3f1-4aeb-afa9-d9bc1118c71e",
"ParentDistributionListURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08",
"CallPickupTimeout": 4,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/DtmfAccessId. | GET | /api/device/cuc/DtmfAccessId/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/DtmfAccessId as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/DtmfAccessId/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/DtmfAccessId/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/DtmfAccessId | 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/DtmfAccessId; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/DtmfAccessId/[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/DtmfAccessId and the JSON format can be used to import instances of device/cuc/DtmfAccessId.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/DtmfAccessId/[pkid] | hierarchy=[hierarchy] | The device/cuc/DtmfAccessId instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/DtmfAccessId/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/DtmfAccessId. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/DtmfAccessId/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |