[Index]
Model ref.: relation/ClusterwideCallPark_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": {
"clusterwideData": {
"type": "object",
"properties": {
"clusterwideFlag": {
"required": false,
"type": "string",
"description": "Clusterwide Call Park Setting on CallManager",
"title": "Clusterwide Enabled"
},
"description": {
"type": "string",
"title": "Description"
},
"callManagerName": {
"type": "string",
"title": "CUCM Server"
},
"startNumber": {
"is_password": false,
"title": "First Call Park Number",
"pattern": "(\\*|\\#)?[0-9]*$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"routePartitionName": {
"type": "string",
"title": "Partition"
},
"rangeSize": {
"is_password": false,
"description": "Range Size - Can be any block size, not just 10, 100 etc",
"title": "Range Size",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"title": "Clusterwide Data"
},
"pattern": {
"description": " Enter the call park extension number. You can enter literal digits or the wildcard character X (the system allows one or two Xs). For example, enter 5555 to define a single call park extension number of 5555 or enter 55XX to define a range of call park extension numbers from 5500 to 5599. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You can create a maximum of 100 call park numbers with one call park range definition. Make sure that the call park numbers are unique. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n You cannot overlap call park numbers between \n Cisco Unified Communications Manager servers. Ensure that each \n Cisco Unified Communications Manager server has its own number range. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The call park range is selected from the list of servers where the call originates. For example, if phone\u00a0A (registered to node\u00a0A) calls phone \u00a0B (registered to node\u00a0B) and the phone\u00a0B user presses Park, phone\u00a0B requires a call park range in the CSS that resides on node\u00a0A. In a multinode environment where phones and gateways communicate with various nodes and where calls that originate from any server may need to be parked, the phones require a CSS that contains call park ranges from all servers. \n \n \n ",
"title": "Call Park Number/Range",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"callManagerName": {
"description": " Using the drop-down list box, choose the \n Cisco Unified Communications Manager to which these call park numbers apply. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You can create a maximum of 100 call park numbers with one call park range definition. Make sure that the call park numbers are unique. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n You cannot overlap call park numbers between \n Cisco Unified Communications Manager servers. Ensure that each \n Cisco Unified Communications Manager server has its own number range. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The call park range is selected from the list of servers where the call originates. For example, if Phone A (registered to node A) calls Phone B (registered to Node B) and the phone B user presses Park, Phone B requires a call park range in the CSS that resides on Node A. In a multinode environment comprised of phones and gateways talking to various nodes, where calls originating from any server may need to be parked, the phones require a CSS that contains call park ranges from all servers. \n \n \n ",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/CallManager",
"title": "Cisco Unified Communications Manager",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/CallManager/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"routePartitionName": {
"description": " If you want to use a partition to restrict access to the call park numbers, choose the desired partition from the drop-down list box. If you do not want to restrict access to the call park numbers, choose <None> for the partition. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Make sure that the combination of call park extension number and partition is unique within the \n Cisco Unified Communications Manager. \n \n \n ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"title": "Partition",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"description": {
"description": " Provide a brief description of this call park number. The description can include up to 50 characters in any language, but it cannot include double-quotes (\u201c), percentage sign (%), ampersand (&), or angle brackets (<>) ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/ClusterwideCallPark_REL/add/ |
|
The GUI Add form of relation/ClusterwideCallPark_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/ClusterwideCallPark_REL | 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/relation/ClusterwideCallPark_REL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/ClusterwideCallPark_REL/[pkid1]", "/api/relation/ClusterwideCallPark_REL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/ClusterwideCallPark_REL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/ClusterwideCallPark_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/ClusterwideCallPark_REL/export/ |
|
{ "hrefs":["/api/relation/ClusterwideCallPark_REL/[pkid1]", "/api/relation/ClusterwideCallPark_REL/[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 relation/ClusterwideCallPark_REL and the JSON format can be used to import instances of relation/ClusterwideCallPark_REL.
GET http://[host-proxy]/api/relation/ClusterwideCallPark_REL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/ClusterwideCallPark_REL | POST | /api/relation/ClusterwideCallPark_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/ClusterwideCallPark_REL/ |
|
The relation/ClusterwideCallPark_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/ClusterwideCallPark_REL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"bulk_update",
"add",
"tag",
"export",
"tag_version"
],
"pagination": {
"direction": "asc",
"order_by": "pattern",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/ClusterwideCallPark_REL/?skip=0&limit=3&order_by=pattern&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/ClusterwideCallPark_REL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/ClusterwideCallPark_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/ClusterwideCallPark_REL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/ClusterwideCallPark_REL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/ClusterwideCallPark_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideCallPark_REL/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideCallPark_REL/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/ClusterwideCallPark_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/ClusterwideCallPark_REL",
"model_specific_actions": [
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"tag",
"export",
"tag_version"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Call Park Number/Range"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"name": "callManagerName",
"title": "Cisco Unified Communications Manager"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/ClusterwideCallPark_REL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/ClusterwideCallPark_REL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/ClusterwideCallPark_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/ClusterwideCallPark_REL/[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 relation/ClusterwideCallPark_REL and the JSON format can be used to import instances of relation/ClusterwideCallPark_REL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/ClusterwideCallPark_REL/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/ClusterwideCallPark_REL/[pkid] | hierarchy=[hierarchy] | The relation/ClusterwideCallPark_REL instance with [pkid]. |