[Index]
Model ref.: device/cucm/MohAudioSource
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": {
"name": {
"title": "Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"sourceId": {
"title": "Source Id",
"minItems": 1,
"required": true,
"choices": [
{
"value": "0",
"title": "0"
},
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "10",
"title": "10"
},
{
"value": "11",
"title": "11"
},
{
"value": "12",
"title": "12"
},
{
"value": "13",
"title": "13"
},
{
"value": "14",
"title": "14"
},
{
"value": "15",
"title": "15"
},
{
"value": "16",
"title": "16"
},
{
"value": "17",
"title": "17"
},
{
"value": "18",
"title": "18"
},
{
"value": "19",
"title": "19"
},
{
"value": "20",
"title": "20"
},
{
"value": "21",
"title": "21"
},
{
"value": "22",
"title": "22"
},
{
"value": "23",
"title": "23"
},
{
"value": "24",
"title": "24"
},
{
"value": "25",
"title": "25"
},
{
"value": "26",
"title": "26"
},
{
"value": "27",
"title": "27"
},
{
"value": "28",
"title": "28"
},
{
"value": "29",
"title": "29"
},
{
"value": "30",
"title": "30"
},
{
"value": "31",
"title": "31"
},
{
"value": "32",
"title": "32"
},
{
"value": "33",
"title": "33"
},
{
"value": "34",
"title": "34"
},
{
"value": "35",
"title": "35"
},
{
"value": "36",
"title": "36"
},
{
"value": "37",
"title": "37"
},
{
"value": "38",
"title": "38"
},
{
"value": "39",
"title": "39"
},
{
"value": "40",
"title": "40"
},
{
"value": "41",
"title": "41"
},
{
"value": "42",
"title": "42"
},
{
"value": "43",
"title": "43"
},
{
"value": "44",
"title": "44"
},
{
"value": "45",
"title": "45"
},
{
"value": "46",
"title": "46"
},
{
"value": "47",
"title": "47"
},
{
"value": "48",
"title": "48"
},
{
"value": "49",
"title": "49"
},
{
"value": "50",
"title": "50"
},
{
"value": "null",
"title": "null"
},
{
"value": "",
"title": ""
}
],
"maxItems": 1,
"type": [
"integer",
"string"
]
},
"localeAnnouncement": {
"title": "Locale Announcement",
"minItems": 1,
"required": true,
"choices": [
{
"value": "English United States",
"title": "English United States"
}
],
"default": "English United States",
"maxItems": 1,
"type": "string"
},
"sourceFile": {
"title": "Source File",
"minItems": 0,
"required": false,
"choices": [
[
"Disabled",
""
],
[
"/dev/dsp",
"/dev/dsp"
]
],
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"isExternalSource": {
"minItems": 1,
"required": true,
"type": "boolean",
"maxItems": 1,
"title": "Is External Source"
},
"initialAnnouncementPlayed": {
"minItems": 0,
"required": false,
"type": "boolean",
"maxItems": 1,
"title": "Initial Announcement Played"
},
"multicast": {
"minItems": 1,
"required": true,
"type": "boolean",
"maxItems": 1,
"title": "Multicast"
},
"periodicAnnouncement": {
"target": "/api/device/cucm/Announcement/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Announcement",
"title": "Periodic Announcement",
"type": [
"string",
"null"
]
},
"initialAnnouncement": {
"minItems": 1,
"required": true,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Initial Announcement"
},
"periodicAnnouncementInterval": {
"title": "Periodic Announcement Interval",
"minItems": 1,
"required": true,
"default": 30,
"maxItems": 1,
"type": "integer"
},
"mohFileStatus": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Moh File Status"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/MohAudioSource/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/MohAudioSource/[pkid1]", "/api/device/cucm/MohAudioSource/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/MohAudioSource/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/MohAudioSource/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/MohAudioSource/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/MohAudioSource/[pkid1]", "/api/v0/device/cucm/MohAudioSource/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/MohAudioSource/?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/MohAudioSource |
|
{"hrefs": ["/api/device/cucm/MohAudioSource/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/MohAudioSource |
|
{"hrefs": ["/api/device/cucm/MohAudioSource/[pkid1]", "/api/device/cucm/MohAudioSource/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/MohAudioSource; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/MohAudioSource/export/ |
|
{ "hrefs":["/api/device/cucm/MohAudioSource/[pkid1]", "/api/device/cucm/MohAudioSource/[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/MohAudioSource and the JSON format can be used to import instances of device/cucm/MohAudioSource.
GET http://[host-proxy]/api/device/cucm/MohAudioSource/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/MohAudioSource | POST | /api/device/cucm/MohAudioSource/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/MohAudioSource/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/MohAudioSource/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/MohAudioSource/ |
|
The device/cucm/MohAudioSource schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/MohAudioSource instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "sourceId",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/MohAudioSource/?skip=0&limit=3&order_by=sourceId&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"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": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/MohAudioSource/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/MohAudioSource/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/MohAudioSource",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohAudioSource/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/MohAudioSource/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/MohAudioSource/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/MohAudioSource/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/MohAudioSource/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohAudioSource/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohAudioSource/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohAudioSource",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "sourceId",
"title": "Source Id"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd2dd34544b7001860a872",
"meta": {
"tags": [],
"cached": true,
"title": "SampleAudioSource",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd2dd34544b7001860a872",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2dd34544b7001860a872/?model_type=device/cucm/MohAudioSource",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohAudioSource",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd2dd34544b7001860a872"
],
"summary_attrs": [
{
"name": "sourceId",
"title": "Source Id"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "SampleAudioSource",
"sourceId": 1,
"localeAnnouncement": "English United States",
"sourceFile": "SampleAudioSource.xml",
"isExternalSource": false,
"periodicAnnouncementInterval": 30,
"initialAnnouncementPlayed": true,
"multicast": false,
"mohFileStatus": 0,
"periodicAnnouncement": null,
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"initialAnnouncement": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "5dcd18d033fc9b0018900d15",
"meta": {
"tags": [],
"cached": true,
"title": "SampleAudioSource",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd183c56b5de00189141b0",
"href": "/api/v0/data/CallManager/5dcd183c56b5de00189141b0"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd18d033fc9b0018900d15",
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd18d033fc9b0018900d15/?model_type=device/cucm/MohAudioSource",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/MohAudioSource/5dcd18d033fc9b0018900d15/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/MohAudioSource",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd18d033fc9b0018900d15"
],
"summary_attrs": [
{
"name": "sourceId",
"title": "Source Id"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "SampleAudioSource",
"sourceId": 1,
"localeAnnouncement": "English United States",
"sourceFile": "SampleAudioSource.xml",
"isExternalSource": false,
"periodicAnnouncementInterval": 30,
"initialAnnouncementPlayed": true,
"multicast": false,
"mohFileStatus": 0,
"periodicAnnouncement": null,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"initialAnnouncement": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5dcdc1eb56b5de0018923b26",
"meta": {
"tags": [],
"cached": true,
"title": "SampleAudioSource",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcdc1ad4544b700186186ca",
"href": "/api/v0/data/CallManager/5dcdc1ad4544b700186186ca"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcdc1eb56b5de0018923b26",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/"
}
],
"parent": [
{
"pkid": "5dcd181e33fc9b0018900610",
"href": "/api/data/HierarchyNode/5dcd181e33fc9b0018900610"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcdc1eb56b5de0018923b26/?model_type=device/cucm/MohAudioSource",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/MohAudioSource/5dcdc1eb56b5de0018923b26/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohAudioSource",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd181e33fc9b0018900610",
"5dcdc1eb56b5de0018923b26"
],
"summary_attrs": [
{
"name": "sourceId",
"title": "Source Id"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "SampleAudioSource",
"sourceId": 1,
"localeAnnouncement": "English United States",
"sourceFile": "SampleAudioSource.xml",
"isExternalSource": false,
"periodicAnnouncementInterval": 30,
"initialAnnouncementPlayed": true,
"multicast": false,
"mohFileStatus": 0,
"periodicAnnouncement": null,
"hierarchy_friendly_name": "GeoLogic (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.17, 8443, hcs.CS-P.GeoLogic",
"initialAnnouncement": null,
"hierarchy_path": "sys.hcs.CS-P.GeoLogic"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd2dd34544b7001860a872",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "SampleAudioSource",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"self": [
{
"pkid": "5dcd2dd34544b7001860a872",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2dd34544b7001860a872/?hierarchy=[hierarchy]&model_type=device/cucm/MohAudioSource",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohAudioSource/5dcd2dd34544b7001860a872/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohAudioSource",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd2dd34544b7001860a872"
],
"summary_attrs": [
{
"name": "sourceId",
"title": "Source Id"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "SampleAudioSource",
"sourceId": 1,
"localeAnnouncement": "English United States",
"sourceFile": "SampleAudioSource.xml",
"isExternalSource": false,
"initialAnnouncementPlayed": true,
"multicast": false,
"periodicAnnouncement": null,
"initialAnnouncement": null,
"periodicAnnouncementInterval": 30,
"mohFileStatus": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/MohAudioSource. | GET | /api/device/cucm/MohAudioSource/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/MohAudioSource as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/MohAudioSource/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/MohAudioSource/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/MohAudioSource/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/MohAudioSource/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/MohAudioSource | 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/MohAudioSource; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/MohAudioSource/[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/MohAudioSource and the JSON format can be used to import instances of device/cucm/MohAudioSource.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/MohAudioSource/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/MohAudioSource instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/MohAudioSource/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/MohAudioSource. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/MohAudioSource/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |