[Index]
Webex Calling Call Park Groups
Model ref.: relation/WebexCallParkGroup
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": {
"parkgrp_id": {
"title": "parkgrp_key",
"type": "string"
},
"id": {
"title": "id",
"type": "string"
},
"locationId": {
"title": "locationId",
"type": "string",
"required": true,
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/Location",
"choices": []
},
"locationName": {
"title": "Location",
"type": "string",
"readonly": true
},
"name": {
"title": "Name",
"type": "string",
"required": true,
"readonly": true
},
"parkOnAgentsEnabled": {
"title": "Use Members as Park Destinations",
"description": "The member list is configured as park destination list for this call park group. Deselect to add Call Park Extensions",
"type": "boolean",
"readonly": true
},
"agents": {
"title": "Agents",
"description": "People, workspaces and virtual lines that are eligible to receive calls",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Agent",
"description": "id",
"format": "uri",
"target_attr": "email",
"target": "/api/device/spark/User/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/User",
"choices": []
},
"type": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE",
"VIRTUAL_LINE"
],
"title": "Type",
"description": "Type of the person, workspace or virtual line",
"readonly": true
},
"firstName": {
"type": "string",
"title": "First Name",
"description": "First name of a person, workspace or virtual line",
"readonly": true
},
"lastName": {
"type": "string",
"title": "Last Name",
"description": "Last name of a person, workspace or virtual line",
"readonly": true
},
"displayName": {
"type": "string",
"title": "Display Name",
"description": "Display name of a person, workspace or virtual line",
"readonly": true
},
"email": {
"type": "string",
"title": "Email",
"description": "Email of a person, workspace or virtual line",
"readonly": true
},
"numbers": {
"type": "array",
"title": "Numbers",
"description": "List of phone numbers of a person, workspace or virtual line",
"readonly": true,
"required": false,
"items": {
"type": "object",
"properties": {
"external": {
"type": "string",
"title": "External",
"description": "Phone number of a person or workspace"
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Extension of a person or workspace"
},
"primary": {
"type": "boolean",
"title": "Primary",
"description": "Flag to indicate a primary phone"
}
}
}
}
}
}
},
"callParkExtensions": {
"title": "Park Destinations",
"description": "Manage the park destinations where this group parks calls",
"required": false,
"type": "array",
"readonly": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "A unique name for the call park extension"
},
"extension": {
"type": "string",
"title": "Extension",
"description": "The extension for the call park"
},
"id": {
"type": "string",
"title": "Id"
}
}
}
},
"recall": {
"title": "Recall To",
"description": "If the users assigned in the previous step do not pick up the call that is parked, then the call is rerouted/recalled to the following options based on the selection here",
"required": false,
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"ALERT_PARKING_USER_ONLY",
"ALERT_PARKING_USER_FIRST_THEN_HUNT_GROUP",
"ALERT_HUNT_GROUP_ONLY"
],
"choices": [
{
"title": "Only alert the parking user",
"value": "ALERT_PARKING_USER_ONLY"
},
{
"title": "Alert the parking user first, then the hunt group",
"value": "ALERT_PARKING_USER_FIRST_THEN_HUNT_GROUP"
},
{
"title": "Alert hunt group only",
"value": "ALERT_HUNT_GROUP_ONLY"
}
],
"title": "Option",
"description": "Call park recall options"
},
"huntGroupId": {
"type": "string",
"title": "HuntGroup ID",
"description": "hunt group ID for call park recall alternate destination"
},
"huntGroupName": {
"type": "string",
"title": "HuntGroup Name",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/HuntGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"description": "Unique name for the hunt group",
"target_model_type": "device/spark/HuntGroup",
"choices": []
}
}
},
"noinstance": {
"title": "Noinstance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexCallParkGroup/add/ |
|
The GUI Add form of relation/WebexCallParkGroup 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/WebexCallParkGroup | 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/WebexCallParkGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexCallParkGroup/[pkid1]", "/api/relation/WebexCallParkGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexCallParkGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexCallParkGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexCallParkGroup/export/ |
|
{ "hrefs":["/api/relation/WebexCallParkGroup/[pkid1]", "/api/relation/WebexCallParkGroup/[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/WebexCallParkGroup and the JSON format can be used to import instances of relation/WebexCallParkGroup.
GET http://[host-proxy]/api/relation/WebexCallParkGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebexCallParkGroup | POST | /api/relation/WebexCallParkGroup/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/WebexCallParkGroup/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebexCallParkGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexCallParkGroup/ |
|
The relation/WebexCallParkGroup schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexCallParkGroup instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/WebexCallParkGroup/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"clone",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/WebexCallParkGroup",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "Location"
},
{
"name": "parkOnAgentsEnabled",
"title": "Use Members as Park Destinations"
},
{
"name": "recall.option",
"title": "Option",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "recall.huntGroupName",
"title": "HuntGroup Name",
"allow_ordering": false,
"allow_filtering": true
},
{
"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": [],
"self": [
{
"href": "/api/relation/WebexCallParkGroup/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"field_display_policy",
"get",
"configuration_template",
"update",
"remove",
"add",
"clone",
"export",
"export_bulkload_template"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/WebexCallParkGroup/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/WebexCallParkGroup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/WebexCallParkGroup/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/relation/WebexCallParkGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/WebexCallParkGroup/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/WebexCallParkGroup/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/WebexCallParkGroup/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/WebexCallParkGroup/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebexCallParkGroup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/WebexCallParkGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/WebexCallParkGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebexCallParkGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexCallParkGroup/[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/WebexCallParkGroup and the JSON format can be used to import instances of relation/WebexCallParkGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexCallParkGroup/[pkid] | hierarchy=[hierarchy] | The relation/WebexCallParkGroup instance with [pkid]. |