[Index]
CustomerBuild-AddCiscoUCCX-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoUCCX-WFC_REL
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": {
"relation_UccxServer": {
"items": {
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "Username of the account used for API access.",
"title": "Username"
},
"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"
},
"description": {
"type": "string",
"description": "Description of this UCCX server.",
"title": "Description"
},
"host": {
"required": true,
"type": "string",
"description": "Host name or IP Address of the UCCX server.",
"title": "Host name or IP Address"
},
"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"
},
"shadow": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"title": "Shadow"
},
"password": {
"store_encrypted": true,
"is_password": true,
"type": "string",
"description": "Password of the account used for API access.",
"title": "Password"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Relation Uccx Server"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoUCCX-WFC_REL 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/relation/CustomerBuild-AddCiscoUCCX-WFC_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CustomerBuild-AddCiscoUCCX-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoUCCX-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoUCCX-WFC_REL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/CustomerBuild-AddCiscoUCCX-WFC_REL",
"model_specific_actions": [
"add",
"export",
"get",
"export_bulkload_template",
"list",
"update",
"remove"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoUCCX-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoUCCX-WFC_REL instance with [pkid]. |