[Index]
Model ref.: device/cucm/SoftKeySet
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": {
"softKeyTemplateName": {
"title": "Softkey Template Name",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": "string"
},
"addCallStates": {
"title": "Add Call States",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callState": {
"name": "callState",
"title": "Call State",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"softKeys": {
"description": "List of mandatory keys for each callstate ::\n\t\t\t\t\t\tOn Hook - NewCall\n\t\t\t\t\t\tConnected - End Call\n\t\t\t\t\t\tOn Hold - Resume\n\t\t\t\t\t\tOff Hook - End Call\n\t\t\t\t\t\tConnected Transfer - Transfer\n\t\t\t\t\t\tDigits After First - Backward\n\t\t\t\t\t\tConnected Conference - Conference\n\t\t\t\t\t\tRing Out - End Call\n\t\t\t\t\t\tOff Hook With Feature - End Call\n\t\t\t\t\t",
"title": "Soft Keys",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"softKey": {
"name": "softKey",
"title": "Soft Key",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"positionId": {
"description": "\n\t\t\t\t\t\tRead-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.\n\t\t\t\t\t",
"title": "Position Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer",
"name": "positionId"
},
"softKeyName": {
"name": "softKeyName",
"title": "Soft Key Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
},
"name": "softKeys"
},
"callStateName": {
"name": "callStateName",
"title": "Call State Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"required": true,
"type": "array"
}
}
},
"callStates": {
"title": "Call States",
"minItems": 12,
"required": false,
"maxItems": 12,
"type": [
"object",
"null"
],
"properties": {
"callState": {
"name": "callState",
"title": "Call State",
"minItems": 12,
"items": {
"type": [
"object",
"null"
],
"properties": {
"softKeys": {
"description": "List of mandatory keys for each callstate ::\n\t\t\t\t\t\tOn Hook - NewCall\n\t\t\t\t\t\tConnected - End Call\n\t\t\t\t\t\tOn Hold - Resume\n\t\t\t\t\t\tOff Hook - End Call\n\t\t\t\t\t\tConnected Transfer - Transfer\n\t\t\t\t\t\tDigits After First - Backward\n\t\t\t\t\t\tConnected Conference - Conference\n\t\t\t\t\t\tRing Out - End Call\n\t\t\t\t\t\tOff Hook With Feature - End Call\n\t\t\t\t\t",
"title": "Soft Keys",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"softKey": {
"name": "softKey",
"title": "Soft Key",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"positionId": {
"description": "\n\t\t\t\t\t\tRead-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.\n\t\t\t\t\t",
"title": "Position Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer",
"name": "positionId"
},
"softKeyName": {
"name": "softKeyName",
"format": "uri",
"minItems": 0,
"title": "Softkey Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"store_encrypted": false,
"target_model_type": "device/cucm/SoftKey",
"type": "string",
"target": "/api/device/cucm/SoftKey/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"required": false,
"type": "array"
}
},
"name": "softKeys"
},
"callStateName": {
"name": "callStateName",
"title": "Call State Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"required": true,
"maxItems": 12,
"type": "array"
}
}
},
"name": {
"description": "Not nullable.",
"title": "Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 100,
"type": "string"
},
"removeCallStates": {
"title": "Remove Call States",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callState": {
"name": "callState",
"title": "Call State",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"softKeys": {
"description": "List of mandatory keys for each callstate ::\n\t\t\t\t\t\tOn Hook - NewCall\n\t\t\t\t\t\tConnected - End Call\n\t\t\t\t\t\tOn Hold - Resume\n\t\t\t\t\t\tOff Hook - End Call\n\t\t\t\t\t\tConnected Transfer - Transfer\n\t\t\t\t\t\tDigits After First - Backward\n\t\t\t\t\t\tConnected Conference - Conference\n\t\t\t\t\t\tRing Out - End Call\n\t\t\t\t\t\tOff Hook With Feature - End Call\n\t\t\t\t\t",
"title": "Soft Keys",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"softKey": {
"name": "softKey",
"title": "Soft Key",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"positionId": {
"description": "\n\t\t\t\t\t\tRead-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.\n\t\t\t\t\t",
"title": "Position Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer",
"name": "positionId"
},
"softKeyName": {
"name": "softKeyName",
"title": "Soft Key Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
},
"name": "softKeys"
},
"callStateName": {
"name": "callStateName",
"title": "Call State Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"required": true,
"type": "array"
}
}
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/SoftKeySet/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/SoftKeySet/[pkid1]", "/api/device/cucm/SoftKeySet/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/SoftKeySet/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/SoftKeySet/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/SoftKeySet/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/SoftKeySet/[pkid1]", "/api/v0/device/cucm/SoftKeySet/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/SoftKeySet/?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/SoftKeySet |
|
{"hrefs": ["/api/device/cucm/SoftKeySet/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/SoftKeySet |
|
{"hrefs": ["/api/device/cucm/SoftKeySet/[pkid1]", "/api/device/cucm/SoftKeySet/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/SoftKeySet; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/SoftKeySet/export/ |
|
{ "hrefs":["/api/device/cucm/SoftKeySet/[pkid1]", "/api/device/cucm/SoftKeySet/[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/SoftKeySet and the JSON format can be used to import instances of device/cucm/SoftKeySet.
GET http://[host-proxy]/api/device/cucm/SoftKeySet/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/SoftKeySet | POST | /api/device/cucm/SoftKeySet/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/SoftKeySet/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/SoftKeySet/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/SoftKeySet/ |
|
The device/cucm/SoftKeySet schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/SoftKeySet 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": "softKeyTemplateName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/SoftKeySet/?skip=0&limit=3&order_by=softKeyTemplateName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 36
},
"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": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SoftKeySet/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/SoftKeySet/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/SoftKeySet",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SoftKeySet/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/SoftKeySet/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/SoftKeySet/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/SoftKeySet/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/SoftKeySet/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SoftKeySet/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SoftKeySet/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/SoftKeySet",
"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": "softKeyTemplateName",
"title": "Softkey Template 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": "61b12fc9eadb826afd7bab7d",
"meta": {
"tags": [],
"cached": true,
"title": "Cisco Assistant with Feature Hardkeys",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "61b12f01eadb826afd7b7a24",
"href": "/api/v0/data/CallManager/61b12f01eadb826afd7b7a24"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "61b12fc9eadb826afd7bab7d",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/"
}
],
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b12fc9eadb826afd7bab7d/?model_type=device/cucm/SoftKeySet",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/SoftKeySet",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12fc9eadb826afd7bab7d"
],
"summary_attrs": [
{
"name": "softKeyTemplateName",
"title": "Softkey Template 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": {
"softKeyTemplateName": "Cisco Assistant with Feature Hardkeys",
"hierarchy_friendly_name": "CS-P (Provider)",
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"callStates": {
"callState": [
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Forward All"
}
]
},
"callStateName": "On Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Conference List"
},
{
"positionId": 4,
"softKeyName": "Transfer to Voice Mail"
},
{
"positionId": 5,
"softKeyName": "Park"
}
]
},
"callStateName": "Connected"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Resume"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "On Hold"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Answer"
},
{
"positionId": 1,
"softKeyName": "Redirect"
},
{
"positionId": 2,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "Ring In"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Forward All"
},
{
"positionId": 3,
"softKeyName": "Pick Up"
},
{
"positionId": 4,
"softKeyName": "Group Pick Up"
},
{
"positionId": 5,
"softKeyName": "Meet Me"
}
]
},
"callStateName": "Off Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Transfer"
}
]
},
"callStateName": "Connected Transfer"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Backward"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Digits After First"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Conference"
}
]
},
"callStateName": "Connected Conference"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Ring Out"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Off Hook With Feature"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Barge"
},
{
"positionId": 1,
"softKeyName": "NewCall"
}
]
},
"callStateName": "Remote In Use"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Connected No Feature"
}
]
},
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "61b1304deadb826afd7bccc5",
"meta": {
"tags": [],
"cached": true,
"title": "Cisco Assistant with Feature Hardkeys",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "61b12f2feadb826afd7b858f",
"href": "/api/v0/data/CallManager/61b12f2feadb826afd7b858f"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "61b1304deadb826afd7bccc5",
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b1304deadb826afd7bccc5/?model_type=device/cucm/SoftKeySet",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/SoftKeySet/61b1304deadb826afd7bccc5/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/SoftKeySet",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b1304deadb826afd7bccc5"
],
"summary_attrs": [
{
"name": "softKeyTemplateName",
"title": "Softkey Template 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": {
"softKeyTemplateName": "Cisco Assistant with Feature Hardkeys",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"callStates": {
"callState": [
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Forward All"
}
]
},
"callStateName": "On Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Conference List"
},
{
"positionId": 4,
"softKeyName": "Transfer to Voice Mail"
},
{
"positionId": 5,
"softKeyName": "Park"
}
]
},
"callStateName": "Connected"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Resume"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "On Hold"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Answer"
},
{
"positionId": 1,
"softKeyName": "Redirect"
},
{
"positionId": 2,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "Ring In"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Forward All"
},
{
"positionId": 3,
"softKeyName": "Pick Up"
},
{
"positionId": 4,
"softKeyName": "Group Pick Up"
},
{
"positionId": 5,
"softKeyName": "Meet Me"
}
]
},
"callStateName": "Off Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Transfer"
}
]
},
"callStateName": "Connected Transfer"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Backward"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Digits After First"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Conference"
}
]
},
"callStateName": "Connected Conference"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Ring Out"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Off Hook With Feature"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Barge"
},
{
"positionId": 1,
"softKeyName": "NewCall"
}
]
},
"callStateName": "Remote In Use"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Connected No Feature"
}
]
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "61b1315deadb826afd7c3461",
"meta": {
"tags": [],
"cached": true,
"title": "Cisco Assistant with Feature Hardkeys",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "61b12f7ceadb826afd7b9861",
"href": "/api/v0/data/CallManager/61b12f7ceadb826afd7b9861"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "61b1315deadb826afd7c3461",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/61b1315deadb826afd7c3461/?model_type=device/cucm/SoftKeySet",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/SoftKeySet/61b1315deadb826afd7c3461/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/SoftKeySet",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b1315deadb826afd7c3461"
],
"summary_attrs": [
{
"name": "softKeyTemplateName",
"title": "Softkey Template 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": {
"softKeyTemplateName": "Cisco Assistant with Feature Hardkeys",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"callStates": {
"callState": [
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Forward All"
}
]
},
"callStateName": "On Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Conference List"
},
{
"positionId": 4,
"softKeyName": "Transfer to Voice Mail"
},
{
"positionId": 5,
"softKeyName": "Park"
}
]
},
"callStateName": "Connected"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Resume"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "On Hold"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Answer"
},
{
"positionId": 1,
"softKeyName": "Redirect"
},
{
"positionId": 2,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "Ring In"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Forward All"
},
{
"positionId": 3,
"softKeyName": "Pick Up"
},
{
"positionId": 4,
"softKeyName": "Group Pick Up"
},
{
"positionId": 5,
"softKeyName": "Meet Me"
}
]
},
"callStateName": "Off Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Transfer"
}
]
},
"callStateName": "Connected Transfer"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Backward"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Digits After First"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Conference"
}
]
},
"callStateName": "Connected Conference"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Ring Out"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Off Hook With Feature"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Barge"
},
{
"positionId": 1,
"softKeyName": "NewCall"
}
]
},
"callStateName": "Remote In Use"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Connected No Feature"
}
]
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "61b12fc9eadb826afd7bab7d",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Cisco Assistant with Feature Hardkeys",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"self": [
{
"pkid": "61b12fc9eadb826afd7bab7d",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "61b12f01eadb826afd7b7a24",
"href": "/api/v0/data/CallManager/61b12f01eadb826afd7b7a24"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b12fc9eadb826afd7bab7d/?hierarchy=[hierarchy]&model_type=device/cucm/SoftKeySet",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SoftKeySet/61b12fc9eadb826afd7bab7d/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/SoftKeySet",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12fc9eadb826afd7bab7d"
],
"summary_attrs": [
{
"name": "softKeyTemplateName",
"title": "Softkey Template 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": {
"softKeyTemplateName": "Cisco Assistant with Feature Hardkeys",
"callStates": {
"callState": [
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Forward All"
}
]
},
"callStateName": "On Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Conference List"
},
{
"positionId": 4,
"softKeyName": "Transfer to Voice Mail"
},
{
"positionId": 5,
"softKeyName": "Park"
}
]
},
"callStateName": "Connected"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Resume"
},
{
"positionId": 1,
"softKeyName": "NewCall"
},
{
"positionId": 2,
"softKeyName": "Redirect"
},
{
"positionId": 3,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "On Hold"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Answer"
},
{
"positionId": 1,
"softKeyName": "Redirect"
},
{
"positionId": 2,
"softKeyName": "Transfer to Voice Mail"
}
]
},
"callStateName": "Ring In"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Forward All"
},
{
"positionId": 3,
"softKeyName": "Pick Up"
},
{
"positionId": 4,
"softKeyName": "Group Pick Up"
},
{
"positionId": 5,
"softKeyName": "Meet Me"
}
]
},
"callStateName": "Off Hook"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Transfer"
}
]
},
"callStateName": "Connected Transfer"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Backward"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Digits After First"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
},
{
"positionId": 2,
"softKeyName": "Conference"
}
]
},
"callStateName": "Connected Conference"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Ring Out"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Redial"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Off Hook With Feature"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Barge"
},
{
"positionId": 1,
"softKeyName": "NewCall"
}
]
},
"callStateName": "Remote In Use"
},
{
"softKeys": {
"softKey": [
{
"positionId": 0,
"softKeyName": "Undefined"
},
{
"positionId": 1,
"softKeyName": "End Call"
}
]
},
"callStateName": "Connected No Feature"
}
]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/SoftKeySet. | GET | /api/device/cucm/SoftKeySet/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/SoftKeySet as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/SoftKeySet/[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/SoftKeySet/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/SoftKeySet/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/SoftKeySet/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/SoftKeySet | 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/SoftKeySet; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/SoftKeySet/[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/SoftKeySet and the JSON format can be used to import instances of device/cucm/SoftKeySet.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/SoftKeySet/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/SoftKeySet instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/SoftKeySet/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/SoftKeySet. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/SoftKeySet/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |