[Index]
This model stores information about a UCCX server
Model ref.: data/UccxServer
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": { "host": { "required": true, "type": "string", "description": "Host name or IP Address of the UCCX server.", "title": "Host name or IP Address" }, "description": { "type": "string", "description": "Description of this UCCX server.", "title": "Description" }, "version": { "description": "Version of the UCCX server.", "title": "Version", "default": "11.6.1", "required": true, "choices": [ { "value": "11.6.1", "title": "11.x / 12.x" } ], "type": "string" }, "username": { "required": true, "type": "string", "description": "Username of the account used for API access.", "title": "Username" }, "password": { "is_password": true, "description": "Password of the account used for API access.", "title": "Password", "store_encrypted": true, "type": "string" }, "cucm_app_users": { "items": { "type": "object", "properties": { "app_user_id": { "type": "string", "description": "Select an Cisco UCM Application User ID that will be associated with Agent controlled devices. Typically the rmcm user is used for this purpose, but other users can also be configured for other purposes like call recording etc.", "title": "Cisco UCM Application User ID" } } }, "type": "array", "description": "Cisco Call Manager application users to use for agent device association.", "title": "Application Users" } }, "schema_version": "1.0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/UccxServer/add/ |
|
The GUI Add form of data/UccxServer as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/data/UccxServer | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/UccxServer/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/UccxServer/[pkid1]", "/api/data/UccxServer/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/UccxServer/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/UccxServer/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/UccxServer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/UccxServer/[pkid1]", "/api/v0/data/UccxServer/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/UccxServer/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/UccxServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/UccxServer/export/ |
|
{ "hrefs":["/api/data/UccxServer/[pkid1]", "/api/data/UccxServer/[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 data/UccxServer and the JSON format can be used to import instances of data/UccxServer.
GET http://[host-proxy]/api/data/UccxServer/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/UccxServer | POST | /api/data/UccxServer/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/UccxServer/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/data/UccxServer/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/UccxServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/UccxServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/UccxServer/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/UccxServer/ |
|
The data/UccxServer schema and all instances as JSON. |
(The list will return 0 to 3 data/UccxServer instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 1, "total_limit": null, "order_by": "host", "direction": "asc", "current": "/api/data/UccxServer/?skip=0&limit=3&order_by=host&direction=asc&traversal=down" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/UccxServer", "summary_attrs": [ { "name": "host", "title": "Host name or IP Address" }, { "name": "description", "title": "Description" }, { "name": "version", "title": "Version" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "transform", "remove", "tag", "tag_version", "update" ], "schema_version": "1.0.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/UccxServer/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/UccxServer/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/data/UccxServer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/UccxServer/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/data/UccxServer/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/UccxServer/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/UccxServer/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/UccxServer/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/UccxServer/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/UccxServer/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/UccxServer/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/UccxServer/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "transform": { "method": "GET", "class": "transform", "href": "/api/data/UccxServer/transform/?hierarchy=[hierarchy]", "support_async": false, "title": "Transform Template" } } ] }, "resources": [ { "data": { "host": "10.120.11.145", "description": "UCCX auto test suite", "version": "11.6.1", "username": "ccmadmin", "password": "==$UTz98db9O4mbqGAX$5WnKV8+5Bxk=$==", "cucm_app_users": [ { "app_user_id": "ccmadmin" }, { "app_user_id": "presencevieweradmin" } ], "pkid": "667883c6770d07b8daf08bea", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" }, "meta": { "model_type": "data/UccxServer", "summary_attrs": [ { "name": "host", "title": "Host name or IP Address" }, { "name": "description", "title": "Description" }, { "name": "version", "title": "Version" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "10.120.11.145", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "parent": [ { "pkid": "5ae89ea2affa931cce38a523", "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "self": [ { "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/", "pkid": "667883c6770d07b8daf08be9" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "667883c6770d07b8daf08be9" ], "schema_version": "1.0.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "667883c6770d07b8daf08be9" } ] }
(Show the first instance)
{ "data": { "host": "10.120.11.145", "description": "UCCX auto test suite", "version": "11.6.1", "username": "ccmadmin", "password": "==$UTz98db9O4mbqGAX$5WnKV8+5Bxk=$==", "cucm_app_users": [ { "app_user_id": "ccmadmin" }, { "app_user_id": "presencevieweradmin" } ], "pkid": "667883c6770d07b8daf08bea" }, "meta": { "model_type": "data/UccxServer", "summary_attrs": [ { "name": "host", "title": "Host name or IP Address" }, { "name": "description", "title": "Description" }, { "name": "version", "title": "Version" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "10.120.11.145", "business_key": {}, "api_version": "21.2", "cached": false, "references": { "parent": [ { "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523", "pkid": "5ae89ea2affa931cce38a523" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "children": [], "self": [ { "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/", "pkid": "667883c6770d07b8daf08be9" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "667883c6770d07b8daf08be9" ], "schema_version": "1.0.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/UccxServer/667883c6770d07b8daf08be9/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "pkid": "667883c6770d07b8daf08be9" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/UccxServer. | GET | /api/data/UccxServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/UccxServer as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Transform Template | GET | /api/data/UccxServer/transform/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/UccxServer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/UccxServer/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/UccxServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/UccxServer/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/UccxServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/UccxServer/[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 data/UccxServer and the JSON format can be used to import instances of data/UccxServer.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/UccxServer/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/UccxServer/[pkid] | hierarchy=[hierarchy] | The data/UccxServer instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/UccxServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/UccxServer. |