[Index]
Model ref.: device/msteamsonline/CsTeamsVoiceApplicationsPolicy
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": {
"Identity": {
"name": "Identity",
"type": "string",
"title": "Identity",
"required": true
},
"AllowAutoAttendantBusinessHoursGreetingChange": {
"name": "AllowAutoAttendantBusinessHoursGreetingChange",
"type": "boolean",
"title": "Allow Auto Attendant Business Hours Greeting Change"
},
"AllowAutoAttendantAfterHoursGreetingChange": {
"name": "AllowAutoAttendantAfterHoursGreetingChange",
"type": "boolean",
"title": "Allow Auto Attendant After Hours Greeting Change"
},
"AllowAutoAttendantHolidayGreetingChange": {
"name": "AllowAutoAttendantHolidayGreetingChange",
"type": "boolean",
"title": "Allow Auto Attendant Holiday Greeting Change"
},
"AllowAutoAttendantBusinessHoursChange": {
"name": "AllowAutoAttendantBusinessHoursChange",
"type": "boolean",
"title": "Allow Auto Attendant Business Hours Change"
},
"AllowAutoAttendantHolidaysChange": {
"name": "AllowAutoAttendantHolidaysChange",
"type": "boolean",
"title": "Allow Auto Attendant Holidays Change"
},
"AllowAutoAttendantTimeZoneChange": {
"name": "AllowAutoAttendantTimeZoneChange",
"type": "boolean",
"title": "Allow Auto Attendant Time Zone Change"
},
"AllowAutoAttendantLanguageChange": {
"name": "AllowAutoAttendantLanguageChange",
"type": "boolean",
"title": "Allow Auto Attendant Language Change"
},
"AllowAutoAttendantBusinessHoursRoutingChange": {
"name": "AllowAutoAttendantBusinessHoursRoutingChange",
"type": "boolean",
"title": "Allow Auto Attendant Business Hours Routing Change"
},
"AllowAutoAttendantAfterHoursRoutingChange": {
"name": "AllowAutoAttendantAfterHoursRoutingChange",
"type": "boolean",
"title": "Allow Auto Attendant After Hours Routing Change"
},
"AllowAutoAttendantHolidayRoutingChange": {
"name": "AllowAutoAttendantHolidayRoutingChange",
"type": "boolean",
"title": "Allow Auto Attendant Holiday Routing Change"
},
"AllowCallQueueWelcomeGreetingChange": {
"name": "AllowCallQueueWelcomeGreetingChange",
"type": "boolean",
"title": "Allow Call Queue Welcome Greeting Change"
},
"AllowCallQueueMusicOnHoldChange": {
"name": "AllowCallQueueMusicOnHoldChange",
"type": "boolean",
"title": "Allow Call Queue Music On Hold Change"
},
"AllowCallQueueOverflowSharedVoicemailGreetingChange": {
"name": "AllowCallQueueOverflowSharedVoicemailGreetingChange",
"type": "boolean",
"title": "Allow Call Queue Over flow Shared Voicemail Greeting Change"
},
"AllowCallQueueTimeoutSharedVoicemailGreetingChange": {
"name": "AllowCallQueueTimeoutSharedVoicemailGreetingChange",
"type": "boolean",
"title": "Allow Call Queue Timeout Shared Voicemail Greeting Change"
},
"AllowCallQueueNoAgentSharedVoicemailGreetingChange": {
"name": "AllowCallQueueNoAgentSharedVoicemailGreetingChange",
"type": "boolean",
"title": "Allow Call Queue No Agent Shared Voicemail Greeting Change"
},
"AllowCallQueueLanguageChange": {
"name": "AllowCallQueueLanguageChange",
"type": "boolean",
"title": "Allow Call Queue Language Change"
},
"AllowCallQueueMembershipChange": {
"name": "AllowCallQueueMembershipChange",
"type": "boolean",
"title": "Allow Call Queue Membership Change"
},
"AllowCallQueueConferenceModeChange": {
"name": "AllowCallQueueConferenceModeChange",
"type": "boolean",
"title": "Allow Call Queue Conference Mode Change"
},
"AllowCallQueueRoutingMethodChange": {
"name": "AllowCallQueueRoutingMethodChange",
"type": "boolean",
"title": "Allow Call Queue Routing Method Change"
},
"AllowCallQueuePresenceBasedRoutingChange": {
"name": "AllowCallQueuePresenceBasedRoutingChange",
"type": "boolean",
"title": "Allow Call Queue Presence Based Routing Change"
},
"AllowCallQueueOptOutChange": {
"name": "AllowCallQueueOptOutChange",
"type": "boolean",
"title": "Allow Call Queue Opt Out Change"
},
"AllowCallQueueOverflowRoutingChange": {
"name": "AllowCallQueueOverflowRoutingChange",
"type": "boolean",
"title": "Allow Call Queue Overflow Routing Change"
},
"AllowCallQueueTimeoutRoutingChange": {
"name": "AllowCallQueueTimeoutRoutingChange",
"type": "boolean",
"title": "Allow Call Queue Timeout Routing Change"
},
"AllowCallQueueNoAgentsRoutingChange": {
"name": "AllowCallQueueNoAgentsRoutingChange",
"type": "boolean",
"title": "Allow Call Queue NoAgents Routing Change"
},
"AllowCallQueueAgentOptChange": {
"name": "AllowCallQueueAgentOptChange",
"type": "boolean",
"title": "Allow Call Queue Agent Opt Change"
},
"CallQueueAgentMonitorMode": {
"name": "CallQueueAgentMonitorMode",
"type": "string",
"title": "Call Queue Agent Monitor Mode",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "Monitor",
"value": "Monitor"
},
{
"title": "Whisper",
"value": "Whisper"
},
{
"title": "Barge",
"value": "Barge"
},
{
"title": "Takeover",
"value": "Takeover"
}
]
},
"CallQueueAgentMonitorNotificationMode": {
"name": "CallQueueAgentMonitorNotificationMode",
"type": "string",
"title": "Call Queue Agent Monitor Notification Mode",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "Agent",
"value": "Agent"
}
]
},
"RealTimeAutoAttendantMetricsPermission": {
"name": "RealTimeAutoAttendantMetricsPermission",
"type": "string",
"title": "Real Time Auto Attendant Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
}
]
},
"RealTimeCallQueueMetricsPermission": {
"name": "RealTimeCallQueueMetricsPermission",
"type": "string",
"title": "Real Time Call Queue Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
}
]
},
"RealTimeAgentMetricsPermission": {
"name": "RealTimeAgentMetricsPermission",
"type": "string",
"title": "Real Time Agent Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
},
{
"title": "All",
"value": "All"
}
]
},
"HistoricalAutoAttendantMetricsPermission": {
"name": "HistoricalAutoAttendantMetricsPermission",
"type": "string",
"title": "Historical Auto Attendant Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
},
{
"title": "All",
"value": "All"
}
]
},
"HistoricalCallQueueMetricsPermission": {
"name": "HistoricalCallQueueMetricsPermission",
"type": "string",
"title": "Historical Call Queue Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
},
{
"title": "All",
"value": "All"
}
]
},
"HistoricalAgentMetricsPermission": {
"name": "HistoricalAgentMetricsPermission",
"type": "string",
"title": "Historical Agent Metrics Permission",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "AuthorizedOnly",
"value": "AuthorizedOnly"
},
{
"title": "All",
"value": "All"
}
]
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/add/ |
|
The GUI Add form of device/msteamsonline/CsTeamsVoiceApplicationsPolicy 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/device/msteamsonline/CsTeamsVoiceApplicationsPolicy | 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/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid1]", "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid1]", "/api/v0/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsTeamsVoiceApplicationsPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid1]", "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[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 device/msteamsonline/CsTeamsVoiceApplicationsPolicy and the JSON format can be used to import instances of device/msteamsonline/CsTeamsVoiceApplicationsPolicy.
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsTeamsVoiceApplicationsPolicy | POST | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/ |
|
The device/msteamsonline/CsTeamsVoiceApplicationsPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsTeamsVoiceApplicationsPolicy instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Identity",
"direction": "asc",
"current": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=down"
},
"operations": [
"list",
"add"
],
"meta": {
"model_type": "device/msteamsonline/CsTeamsVoiceApplicationsPolicy",
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"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": [
"list",
"get",
"add",
"update",
"remove",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"schema_version": "2019.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/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/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/+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/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/+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/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsTeamsVoiceApplicationsPolicy. | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsTeamsVoiceApplicationsPolicy as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/msteamsonline/CsTeamsVoiceApplicationsPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[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 device/msteamsonline/CsTeamsVoiceApplicationsPolicy and the JSON format can be used to import instances of device/msteamsonline/CsTeamsVoiceApplicationsPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsTeamsVoiceApplicationsPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsTeamsVoiceApplicationsPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsVoiceApplicationsPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |