[Index]
Model ref.: relation/ClusterwideDirectedCallPark_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": {
"description": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Description"
},
"retrievalPrefix": {
"description": "The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call. ",
"title": "Retrieval Prefix",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"pattern": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Pattern"
},
"revertCssName": {
"target": "/api/device/cucm/Css/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/Css",
"title": "Revert Css Name",
"type": [
"string",
"null"
]
},
"reversionPattern": {
"description": "The pattern used to revert the call when the parked call is not retrieved within retrieval timer.",
"title": "Reversion Pattern",
"minItems": 0,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"clusterwideData": {
"type": "object",
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"revertCssName": {
"type": "string",
"title": "Revert Css Name"
},
"reversionPattern": {
"type": "string",
"title": "Reversion Pattern"
},
"retrievalPrefix": {
"type": "string",
"title": "Retrieval Prefix"
},
"startNumber": {
"is_password": false,
"title": "First Directed 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"
},
"routePartitionName": {
"target": "/api/device/cucm/RoutePartition/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/RoutePartition",
"title": "Route Partition Name",
"type": [
"string",
"null"
]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/ClusterwideDirectedCallPark_REL/add/ |
|
The GUI Add form of relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/ClusterwideDirectedCallPark_REL/[pkid1]", "/api/relation/ClusterwideDirectedCallPark_REL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/ClusterwideDirectedCallPark_REL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/ClusterwideDirectedCallPark_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/ClusterwideDirectedCallPark_REL/export/ |
|
{ "hrefs":["/api/relation/ClusterwideDirectedCallPark_REL/[pkid1]", "/api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL and the JSON format can be used to import instances of relation/ClusterwideDirectedCallPark_REL.
GET http://[host-proxy]/api/relation/ClusterwideDirectedCallPark_REL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/ClusterwideDirectedCallPark_REL | POST | /api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL/ |
|
The relation/ClusterwideDirectedCallPark_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/ClusterwideDirectedCallPark_REL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/ClusterwideDirectedCallPark_REL",
"model_specific_actions": [
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"tag",
"export",
"tag_version"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "reversionPattern",
"title": "Reversion Pattern"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5fff87b9ce894e001555b37e",
"meta": {
"tags": [],
"cached": true,
"title": "3005",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5fff874fce894e001555ac44",
"href": "/api/v0/data/CallManager/5fff874fce894e001555ac44"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5fff87b9ce894e001555b37e",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/"
}
],
"parent": [
{
"pkid": "5fff8722ce894e001555a689",
"href": "/api/data/HierarchyNode/5fff8722ce894e001555a689"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "relation/ClusterwideDirectedCallPark_REL",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff8722ce894e001555a689",
"5fff87b9ce894e001555b37e"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "reversionPattern",
"title": "Reversion Pattern"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"retrievalPrefix": "9005",
"reversionPattern": null,
"revertCssName": null,
"pattern": "3005",
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"routePartitionName": "Site19",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "5fff87b9ce894e001555b37e",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "3005",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "5fff874fce894e001555ac44",
"href": "/api/v0/data/CallManager/5fff874fce894e001555ac44"
}
],
"self": [
{
"pkid": "5fff87b9ce894e001555b37e",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/"
}
],
"children": [],
"parent": [
{
"pkid": "5fff8722ce894e001555a689",
"href": "/api/data/HierarchyNode/5fff8722ce894e001555a689"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/+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/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/ClusterwideDirectedCallPark_REL/5fff87b9ce894e001555b37e/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "relation/ClusterwideDirectedCallPark_REL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "reversionPattern",
"title": "Reversion Pattern"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"pattern": "3005",
"reversionPattern": null,
"revertCssName": null,
"routePartitionName": "Site19",
"retrievalPrefix": "9005"
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/ClusterwideDirectedCallPark_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/ClusterwideDirectedCallPark_REL and the JSON format can be used to import instances of relation/ClusterwideDirectedCallPark_REL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/ClusterwideDirectedCallPark_REL/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/ClusterwideDirectedCallPark_REL/[pkid]/ | hierarchy=[hierarchy] | The relation/ClusterwideDirectedCallPark_REL instance with [pkid]. |