[Index]
Model ref.: device/cucm/Ddi
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": {
"clause": {
"title": "Clause",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"dialPlanName": {
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/DialPlan",
"title": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"members": {
"title": "Members",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"dialPlanTagName": {
"name": "dialPlanTagName",
"title": "Dial Plan Tag Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
}
}
},
"required": true,
"type": "array"
}
}
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/Ddi/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/Ddi/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/Ddi/[pkid1]", "/api/v0/device/cucm/Ddi/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/Ddi/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/Ddi |
|
{"hrefs": ["/api/device/cucm/Ddi/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/Ddi |
|
{"hrefs": ["/api/device/cucm/Ddi/[pkid1]", "/api/device/cucm/Ddi/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/Ddi; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/Ddi/export/ |
|
{ "hrefs":["/api/device/cucm/Ddi/[pkid1]", "/api/device/cucm/Ddi/[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/cucm/Ddi and the JSON format can be used to import instances of device/cucm/Ddi.
GET http://[host-proxy]/api/device/cucm/Ddi/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/Ddi | POST | /api/device/cucm/Ddi/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/cucm/Ddi/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/Ddi/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/Ddi/ |
|
The device/cucm/Ddi schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/Ddi instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"transform",
"bulk_update_form",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/Ddi/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 93
},
"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/cucm/Ddi/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/cucm/Ddi",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/Ddi/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/cucm/Ddi/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/Ddi/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/Ddi/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/Ddi/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/Ddi/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/Ddi/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/Ddi",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8a7947ce894e001671fd01",
"meta": {
"tags": [],
"cached": true,
"title": "10-10-Dialing",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5e8a78f5ce894e001671eb8b",
"href": "/api/v0/data/CallManager/5e8a78f5ce894e001671eb8b"
}
],
"self": [
{
"pkid": "5e8a7947ce894e001671fd01",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7947ce894e001671fd01/?model_type=device/cucm/Ddi",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/Ddi",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7947ce894e001671fd01"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"name": "10-10-Dialing",
"hierarchy": "5e8a78cdce894e001671e1fb",
"clause": "ACCESS-CODE:AREA-CODE:COUNTRY-CODE:END-OF-DIALING:INTERNATIONAL-ACCESS:INTERNATIONAL-DIRECT-DIAL:INTERNATIONAL-OPERATOR:LOCAL-AREA-CODE:LOCAL-DIRECT-DIAL:LOCAL-OPERATOR:LONG-DISTANCE-DIRECT-DIAL:LONG-DISTANCE-OPERATOR:NATIONAL-NUMBER:OFFICE-CODE:POST-AT:PRE-AT:SATELLITE-SERVICE:SERVICE:SUBSCRIBER",
"dialPlanName": "NANP",
"members": {
"member": [
{
"dialPlanTagName": "SATELLITE-SERVICE"
},
{
"dialPlanTagName": "NATIONAL-NUMBER"
},
{
"dialPlanTagName": "LOCAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "LONG-DISTANCE-DIRECT-DIAL"
},
{
"dialPlanTagName": "LOCAL-OPERATOR"
},
{
"dialPlanTagName": "LONG-DISTANCE-OPERATOR"
},
{
"dialPlanTagName": "AREA-CODE"
},
{
"dialPlanTagName": "LOCAL-AREA-CODE"
},
{
"dialPlanTagName": "OFFICE-CODE"
},
{
"dialPlanTagName": "SUBSCRIBER"
},
{
"dialPlanTagName": "SERVICE"
},
{
"dialPlanTagName": "PRE-AT"
},
{
"dialPlanTagName": "POST-AT"
},
{
"dialPlanTagName": "INTERNATIONAL-ACCESS"
},
{
"dialPlanTagName": "INTERNATIONAL-OPERATOR"
},
{
"dialPlanTagName": "INTERNATIONAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "COUNTRY-CODE"
},
{
"dialPlanTagName": "ACCESS-CODE"
},
{
"dialPlanTagName": "END-OF-DIALING"
}
]
},
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5e8a798dce894e0016720bb8",
"meta": {
"tags": [],
"cached": true,
"title": "10-10-Dialing",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5e8a7923ce894e001671f5a6",
"href": "/api/v0/data/CallManager/5e8a7923ce894e001671f5a6"
}
],
"self": [
{
"pkid": "5e8a798dce894e0016720bb8",
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a798dce894e0016720bb8/?model_type=device/cucm/Ddi",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/Ddi/5e8a798dce894e0016720bb8/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/Ddi",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a798dce894e0016720bb8"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"name": "10-10-Dialing",
"hierarchy": "5e8a78cdce894e001671e1fb",
"clause": "ACCESS-CODE:AREA-CODE:COUNTRY-CODE:END-OF-DIALING:INTERNATIONAL-ACCESS:INTERNATIONAL-DIRECT-DIAL:INTERNATIONAL-OPERATOR:LOCAL-AREA-CODE:LOCAL-DIRECT-DIAL:LOCAL-OPERATOR:LONG-DISTANCE-DIRECT-DIAL:LONG-DISTANCE-OPERATOR:NATIONAL-NUMBER:OFFICE-CODE:POST-AT:PRE-AT:SATELLITE-SERVICE:SERVICE:SUBSCRIBER",
"dialPlanName": "NANP",
"members": {
"member": [
{
"dialPlanTagName": "SATELLITE-SERVICE"
},
{
"dialPlanTagName": "NATIONAL-NUMBER"
},
{
"dialPlanTagName": "LOCAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "LONG-DISTANCE-DIRECT-DIAL"
},
{
"dialPlanTagName": "LOCAL-OPERATOR"
},
{
"dialPlanTagName": "LONG-DISTANCE-OPERATOR"
},
{
"dialPlanTagName": "AREA-CODE"
},
{
"dialPlanTagName": "LOCAL-AREA-CODE"
},
{
"dialPlanTagName": "OFFICE-CODE"
},
{
"dialPlanTagName": "SUBSCRIBER"
},
{
"dialPlanTagName": "SERVICE"
},
{
"dialPlanTagName": "PRE-AT"
},
{
"dialPlanTagName": "POST-AT"
},
{
"dialPlanTagName": "INTERNATIONAL-ACCESS"
},
{
"dialPlanTagName": "INTERNATIONAL-OPERATOR"
},
{
"dialPlanTagName": "INTERNATIONAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "COUNTRY-CODE"
},
{
"dialPlanTagName": "ACCESS-CODE"
},
{
"dialPlanTagName": "END-OF-DIALING"
}
]
},
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5e8a9a21ce894e0016757ae3",
"meta": {
"tags": [],
"cached": true,
"title": "10-10-Dialing",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5e8a99f9ce894e00167574e3",
"href": "/api/v0/data/CallManager/5e8a99f9ce894e00167574e3"
}
],
"self": [
{
"pkid": "5e8a9a21ce894e0016757ae3",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/"
}
],
"parent": [
{
"pkid": "5e8a99e5ce894e0016756f2c",
"href": "/api/data/HierarchyNode/5e8a99e5ce894e0016756f2c"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a9a21ce894e0016757ae3/?model_type=device/cucm/Ddi",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/Ddi/5e8a9a21ce894e0016757ae3/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/Ddi",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a99e5ce894e0016756f2c",
"5e8a9a21ce894e0016757ae3"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"name": "10-10-Dialing",
"hierarchy": "5e8a99e5ce894e0016756f2c",
"clause": "ACCESS-CODE:AREA-CODE:COUNTRY-CODE:END-OF-DIALING:INTERNATIONAL-ACCESS:INTERNATIONAL-DIRECT-DIAL:INTERNATIONAL-OPERATOR:LOCAL-AREA-CODE:LOCAL-DIRECT-DIAL:LOCAL-OPERATOR:LONG-DISTANCE-DIRECT-DIAL:LONG-DISTANCE-OPERATOR:NATIONAL-NUMBER:OFFICE-CODE:POST-AT:PRE-AT:SATELLITE-SERVICE:SERVICE:SUBSCRIBER",
"dialPlanName": "NANP",
"members": {
"member": [
{
"dialPlanTagName": "SATELLITE-SERVICE"
},
{
"dialPlanTagName": "NATIONAL-NUMBER"
},
{
"dialPlanTagName": "LOCAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "LONG-DISTANCE-DIRECT-DIAL"
},
{
"dialPlanTagName": "LOCAL-OPERATOR"
},
{
"dialPlanTagName": "LONG-DISTANCE-OPERATOR"
},
{
"dialPlanTagName": "AREA-CODE"
},
{
"dialPlanTagName": "LOCAL-AREA-CODE"
},
{
"dialPlanTagName": "OFFICE-CODE"
},
{
"dialPlanTagName": "SUBSCRIBER"
},
{
"dialPlanTagName": "SERVICE"
},
{
"dialPlanTagName": "PRE-AT"
},
{
"dialPlanTagName": "POST-AT"
},
{
"dialPlanTagName": "INTERNATIONAL-ACCESS"
},
{
"dialPlanTagName": "INTERNATIONAL-OPERATOR"
},
{
"dialPlanTagName": "INTERNATIONAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "COUNTRY-CODE"
},
{
"dialPlanTagName": "ACCESS-CODE"
},
{
"dialPlanTagName": "END-OF-DIALING"
}
]
},
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "5e8a7947ce894e001671fd01",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "10-10-Dialing",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"self": [
{
"pkid": "5e8a7947ce894e001671fd01",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5e8a78f5ce894e001671eb8b",
"href": "/api/v0/data/CallManager/5e8a78f5ce894e001671eb8b"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7947ce894e001671fd01/?hierarchy=[hierarchy]&model_type=device/cucm/Ddi",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/Ddi/5e8a7947ce894e001671fd01/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/Ddi",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7947ce894e001671fd01"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"clause": "ACCESS-CODE:AREA-CODE:COUNTRY-CODE:END-OF-DIALING:INTERNATIONAL-ACCESS:INTERNATIONAL-DIRECT-DIAL:INTERNATIONAL-OPERATOR:LOCAL-AREA-CODE:LOCAL-DIRECT-DIAL:LOCAL-OPERATOR:LONG-DISTANCE-DIRECT-DIAL:LONG-DISTANCE-OPERATOR:NATIONAL-NUMBER:OFFICE-CODE:POST-AT:PRE-AT:SATELLITE-SERVICE:SERVICE:SUBSCRIBER",
"dialPlanName": "NANP",
"name": "10-10-Dialing",
"members": {
"member": [
{
"dialPlanTagName": "SATELLITE-SERVICE"
},
{
"dialPlanTagName": "NATIONAL-NUMBER"
},
{
"dialPlanTagName": "LOCAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "LONG-DISTANCE-DIRECT-DIAL"
},
{
"dialPlanTagName": "LOCAL-OPERATOR"
},
{
"dialPlanTagName": "LONG-DISTANCE-OPERATOR"
},
{
"dialPlanTagName": "AREA-CODE"
},
{
"dialPlanTagName": "LOCAL-AREA-CODE"
},
{
"dialPlanTagName": "OFFICE-CODE"
},
{
"dialPlanTagName": "SUBSCRIBER"
},
{
"dialPlanTagName": "SERVICE"
},
{
"dialPlanTagName": "PRE-AT"
},
{
"dialPlanTagName": "POST-AT"
},
{
"dialPlanTagName": "INTERNATIONAL-ACCESS"
},
{
"dialPlanTagName": "INTERNATIONAL-OPERATOR"
},
{
"dialPlanTagName": "INTERNATIONAL-DIRECT-DIAL"
},
{
"dialPlanTagName": "COUNTRY-CODE"
},
{
"dialPlanTagName": "ACCESS-CODE"
},
{
"dialPlanTagName": "END-OF-DIALING"
}
]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/Ddi. | GET | /api/device/cucm/Ddi/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/Ddi as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/Ddi/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/Ddi/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/Ddi | 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/cucm/Ddi; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/Ddi/[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/cucm/Ddi and the JSON format can be used to import instances of device/cucm/Ddi.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/Ddi/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/Ddi instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/Ddi/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/Ddi. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/Ddi/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |