[Index]
Webex Auto Attendants
Model ref.: relation/WebexAutoAttendants
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": {
"languageCode": {
"type": "string",
"title": "Language Code"
},
"aa_id": {
"type": "string",
"title": "aa_key"
},
"holidaySchedule": {
"type": "string",
"description": "Holiday defined for the auto attendant",
"title": "Holiday Schedule"
},
"id": {
"type": "string",
"title": "id"
},
"extensionDialing": {
"choices": [
{
"value": "ENTERPRISE",
"title": "ENTERPRISE"
},
{
"value": "GROUP",
"title": "GROUP"
}
],
"enum": [
"ENTERPRISE",
"GROUP"
],
"type": "string",
"description": "Extension dialing setting. If the values are not set default will be set as ENTERPRISE",
"title": "Extension Dialing"
},
"alternateNumbers": {
"items": {
"type": "object",
"properties": {
"tollFreeNumber": {
"type": "boolean",
"description": "tollFreeNumber",
"title": "TollFree Number"
},
"ringPattern": {
"choices": [
{
"value": "NORMAL",
"title": "NORMAL"
},
{
"value": "LONG_LONG",
"title": "LONG_LONG"
},
{
"value": "SHORT_SHORT_LONG",
"title": "SHORT_SHORT_LONG"
},
{
"value": "SHORT_LONG_SHORT",
"title": "SHORT_LONG_SHORT"
}
],
"required": true,
"type": "string",
"description": "ringPattern",
"title": "Ring Pattern"
},
"phoneNumber": {
"type": "string",
"description": "phoneNumber",
"title": "Phone Number"
}
}
},
"type": "array",
"title": "Alternate Numbers"
},
"phoneNumber": {
"type": "string",
"title": "Phone Number"
},
"firstName": {
"required": true,
"type": "string",
"title": "First Name"
},
"noinstance": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Noinstance"
},
"afterHoursMenu": {
"properties": {
"audioAnnouncementFile": {
"properties": {
"mediaFileType": {
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
],
"type": "string",
"title": "File Type"
},
"fileName": {
"readonly": true,
"type": "string",
"title": "File Name"
},
"id": {
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Name",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Announcements",
"type": "string"
},
"level": {
"choices": [
{
"value": "ORGANIZATION",
"title": "Enterprise"
},
{
"value": "LOCATION",
"title": "Location"
}
],
"enum": [
"ORGANIZATION",
"LOCATION"
],
"type": "string",
"description": "Audio announcement file type location",
"title": "Level"
}
},
"required": false,
"type": "object",
"description": "Announcement Audio File details",
"title": "Greeting File"
},
"extensionEnabled": {
"type": "boolean",
"description": "Enable extension dialling without requiring a menu item",
"title": "Extension Dialing"
},
"greeting": {
"choices": [
{
"value": "DEFAULT",
"title": "DEFAULT"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"enum": [
"DEFAULT",
"CUSTOM"
],
"type": "string",
"title": "Greeting"
},
"keyConfigurations": {
"items": {
"type": "object",
"properties": {
"action": {
"choices": [
{
"value": "PLAY_ANNOUNCEMENT",
"title": "Play announcement"
},
{
"value": "TRANSFER_WITH_PROMPT",
"title": "Transfer call with prompt"
},
{
"value": "TRANSFER_WITHOUT_PROMPT",
"title": "Transfer call without prompt"
},
{
"value": "TRANSFER_TO_OPERATOR",
"title": "Transfer call to operator"
},
{
"value": "TRANSFER_TO_MAILBOX",
"title": "Transfer to voicemail"
},
{
"value": "NAME_DIALING",
"title": "Dial by name"
},
{
"value": "EXTENSION_DIALING",
"title": "Dial by extension"
},
{
"value": "REPEAT_MENU",
"title": "Repeat menu"
},
{
"value": "EXIT",
"title": "Exit Menu"
}
],
"enum": [
"PLAY_ANNOUNCEMENT",
"TRANSFER_WITH_PROMPT",
"TRANSFER_WITHOUT_PROMPT",
"TRANSFER_TO_OPERATOR",
"TRANSFER_TO_MAILBOX",
"NAME_DIALING",
"EXTENSION_DIALING",
"REPEAT_MENU",
"EXIT",
"RETURN_TO_PREVIOUS_MENU"
],
"type": "string",
"description": "Action assigned to specific menu key configuration",
"title": "Action"
},
"key_description": {
"type": "string",
"description": "Provide a label for this menu option",
"title": "Description"
},
"audioAnnouncementFile": {
"properties": {
"mediaFileType": {
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
],
"type": "string",
"title": "File Type"
},
"fileName": {
"readonly": true,
"type": "string",
"title": "File Name"
},
"id": {
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Name",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Announcements",
"type": "string"
},
"level": {
"choices": [
{
"value": "ORGANIZATION",
"title": "Enterprise"
},
{
"value": "LOCATION",
"title": "Location"
}
],
"enum": [
"ORGANIZATION",
"LOCATION"
],
"type": "string",
"description": "Audio announcement file type location",
"title": "Level"
}
},
"required": false,
"type": "object",
"description": "Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set",
"title": "Announcement File"
},
"value": {
"type": "string",
"title": "Phone Number or Extension"
},
"key": {
"choices": [
{
"value": "0",
"title": "0"
},
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "#",
"title": "#"
}
],
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"#"
],
"type": "string",
"description": "Key assigned to specific menu configuration",
"title": "Key"
}
}
},
"required": true,
"type": "array",
"description": "Key configurations defined for the auto attendant",
"title": "Key Configurations"
}
},
"required": true,
"type": "object",
"description": "After hours menu defined for the auto attendant",
"title": "After Hours Menu"
},
"tollFreeNumber": {
"type": "boolean",
"description": "Flag to indicate if auto attendant number is toll-free number",
"title": "Toll Free Number"
},
"callForwarding": {
"properties": {
"rules": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name",
"title": "Name"
},
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
},
"id": {
"type": "string",
"description": "id",
"title": "id"
},
"callsFrom": {
"properties": {
"selection": {
"choices": [
{
"value": "ANY",
"title": "ANY"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"type": "string",
"description": "selection",
"title": "Selection"
},
"customNumbers": {
"properties": {
"privateNumberEnabled": {
"type": "boolean",
"description": "privateNumberEnabled",
"title": "Any Private Numbers "
},
"unavailableNumberEnabled": {
"type": "boolean",
"description": "unavailableNumberEnabled",
"title": "Any Unavailable Numbers"
},
"numbers": {
"items": {
"type": "string"
},
"type": "array",
"title": "Numbers"
}
},
"type": "object",
"description": "customNumbers",
"title": "Custom Numbers"
}
},
"type": "object",
"description": "callsFrom",
"title": "Calls From"
},
"businessSchedule": {
"type": "string",
"description": "businessSchedule",
"title": "Business Schedule"
},
"holidaySchedule": {
"type": "string",
"description": "holidaySchedule",
"title": "Holiday Schedule"
},
"forwardTo": {
"properties": {
"selection": {
"choices": [
{
"value": "FORWARD_TO_DEFAULT_NUMBER",
"title": "FORWARD_TO_DEFAULT_NUMBER"
},
{
"value": "FORWARD_TO_SPECIFIED_NUMBER",
"title": "FORWARD_TO_SPECIFIED_NUMBER"
},
{
"value": "DO_NOT_FORWARD",
"title": "DO_NOT_FORWARD"
}
],
"type": "string",
"description": "selection",
"title": "Selection"
},
"phoneNumber": {
"type": "string",
"description": "phoneNumber",
"title": "Phone Number"
}
},
"type": "object",
"description": "forwardTo",
"title": "Forward To"
},
"callsTo": {
"properties": {
"numbers": {
"items": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"description": "Only return call queues with matching primary phone number or extension",
"title": "Phone Number"
},
"type": {
"choices": [
{
"value": "PRIMARY",
"title": "PRIMARY"
},
{
"value": "ALTERNATE",
"title": "ALTERNATE"
}
],
"type": "string",
"description": "Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary or alternate number",
"title": "Type"
},
"extension": {
"type": "string",
"description": "Primary phone extension of the call queue.",
"title": "Extension"
}
}
},
"required": false,
"type": "array",
"description": "Array of numbers to be matched against the calling destination number",
"title": "Calls To Numbers"
}
},
"type": "object",
"description": "callsTo",
"title": "Calls To"
}
}
},
"required": false,
"type": "array",
"description": "rules",
"title": "Rules"
},
"always": {
"type": "object",
"properties": {
"ringReminderEnabled": {
"type": "boolean",
"description": "ringReminderEnabled",
"title": "Ring Reminder Enabled"
},
"destination": {
"type": "string",
"description": "destination",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
},
"sendToVoicemailEnabled": {
"type": "boolean",
"description": "sendToVoicemailEnabled",
"title": "Send To Voicemail Enabled"
}
},
"title": "Always"
},
"selective": {
"type": "object",
"properties": {
"ringReminderEnabled": {
"type": "boolean",
"description": "ringReminderEnabled",
"title": "Ring Reminder Enabled"
},
"destination": {
"type": "string",
"description": "destination",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
},
"sendToVoicemailEnabled": {
"type": "boolean",
"description": "sendToVoicemailEnabled",
"title": "Send To Voicemail Enabled"
}
},
"title": "Selective"
}
},
"required": false,
"type": "object",
"description": "Call Forwarding Settings",
"title": "Call Forwarding Settings"
},
"language": {
"required": true,
"type": "string",
"title": "Language"
},
"businessHoursMenu": {
"properties": {
"audioAnnouncementFile": {
"properties": {
"mediaFileType": {
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
],
"type": "string",
"title": "File Type"
},
"fileName": {
"readonly": true,
"type": "string",
"title": "File Name"
},
"id": {
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Name",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Announcements",
"type": "string"
},
"level": {
"choices": [
{
"value": "ORGANIZATION",
"title": "Enterprise"
},
{
"value": "LOCATION",
"title": "Location"
}
],
"enum": [
"ORGANIZATION",
"LOCATION"
],
"type": "string",
"description": "Audio announcement file type location",
"title": "Level"
}
},
"required": false,
"type": "object",
"description": "Announcement Audio File details",
"title": "Greeting File"
},
"extensionEnabled": {
"type": "boolean",
"description": "Enable extension dialling without requiring a menu item",
"title": "Extension Dialing"
},
"greeting": {
"choices": [
{
"value": "DEFAULT",
"title": "DEFAULT"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"enum": [
"DEFAULT",
"CUSTOM"
],
"type": "string",
"title": "Greeting"
},
"keyConfigurations": {
"items": {
"type": "object",
"properties": {
"action": {
"choices": [
{
"value": "PLAY_ANNOUNCEMENT",
"title": "Play announcement"
},
{
"value": "TRANSFER_WITH_PROMPT",
"title": "Transfer call with prompt"
},
{
"value": "TRANSFER_WITHOUT_PROMPT",
"title": "Transfer call without prompt"
},
{
"value": "TRANSFER_TO_OPERATOR",
"title": "Transfer call to operator"
},
{
"value": "TRANSFER_TO_MAILBOX",
"title": "Transfer to voicemail"
},
{
"value": "NAME_DIALING",
"title": "Dial by name"
},
{
"value": "EXTENSION_DIALING",
"title": "Dial by extension"
},
{
"value": "REPEAT_MENU",
"title": "Repeat menu"
},
{
"value": "EXIT",
"title": "Exit Menu"
}
],
"enum": [
"PLAY_ANNOUNCEMENT",
"TRANSFER_WITH_PROMPT",
"TRANSFER_WITHOUT_PROMPT",
"TRANSFER_TO_OPERATOR",
"TRANSFER_TO_MAILBOX",
"NAME_DIALING",
"EXTENSION_DIALING",
"REPEAT_MENU",
"EXIT",
"RETURN_TO_PREVIOUS_MENU"
],
"type": "string",
"description": "Action assigned to specific menu key configuration",
"title": "Action"
},
"key_description": {
"type": "string",
"description": "Provide a label for this menu option",
"title": "Description"
},
"audioAnnouncementFile": {
"properties": {
"mediaFileType": {
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
],
"type": "string",
"title": "File Type"
},
"fileName": {
"readonly": true,
"type": "string",
"title": "File Name"
},
"id": {
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Name",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Announcements",
"type": "string"
},
"level": {
"choices": [
{
"value": "ORGANIZATION",
"title": "Enterprise"
},
{
"value": "LOCATION",
"title": "Location"
}
],
"enum": [
"ORGANIZATION",
"LOCATION"
],
"type": "string",
"description": "Audio announcement file type location",
"title": "Level"
}
},
"required": false,
"type": "object",
"description": "Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set",
"title": "Announcement File"
},
"value": {
"type": "string",
"title": "Phone Number or Extension"
},
"key": {
"choices": [
{
"value": "0",
"title": "0"
},
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "#",
"title": "#"
}
],
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"#"
],
"type": "string",
"description": "Key assigned to specific menu configuration",
"title": "Key"
}
}
},
"required": true,
"type": "array",
"description": "Key configurations defined for the auto attendant",
"title": "Key Configurations"
}
},
"required": true,
"type": "object",
"description": "Business hours menu defined for the auto attendant",
"title": "Business Hours Menu"
},
"locationId": {
"target": "/api/device/spark/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Location",
"title": "locationId",
"type": "string"
},
"businessSchedule": {
"required": true,
"type": "string",
"description": "Business hours defined for the auto attendant",
"title": "Business Hours Schedule"
},
"nameDialing": {
"choices": [
{
"value": "ENTERPRISE",
"title": "ENTERPRISE"
},
{
"value": "GROUP",
"title": "GROUP"
}
],
"enum": [
"ENTERPRISE",
"GROUP"
],
"type": "string",
"description": "Name dialing setting. If the values are not set default will be set as ENTERPRISE",
"title": "Name Dialing"
},
"name": {
"required": true,
"type": "string",
"title": "Name"
},
"extension": {
"type": "string",
"title": "Extension"
},
"lastName": {
"required": true,
"type": "string",
"title": "Last Name"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"locationName": {
"type": "string",
"title": "locationName"
},
"timeZone": {
"type": "string",
"title": "Time Zone"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexAutoAttendants/add/ |
|
The GUI Add form of relation/WebexAutoAttendants 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/WebexAutoAttendants | 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/WebexAutoAttendants/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexAutoAttendants/[pkid1]", "/api/relation/WebexAutoAttendants/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexAutoAttendants; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexAutoAttendants/export/ |
|
{ "hrefs":["/api/relation/WebexAutoAttendants/[pkid1]", "/api/relation/WebexAutoAttendants/[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/WebexAutoAttendants and the JSON format can be used to import instances of relation/WebexAutoAttendants.
GET http://[host-proxy]/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebexAutoAttendants | POST | /api/relation/WebexAutoAttendants/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/WebexAutoAttendants/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebexAutoAttendants/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexAutoAttendants/ |
|
The relation/WebexAutoAttendants schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexAutoAttendants instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/WebexAutoAttendants/?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/WebexAutoAttendants/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/WebexAutoAttendants/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/WebexAutoAttendants/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/WebexAutoAttendants/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/WebexAutoAttendants/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/WebexAutoAttendants/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/WebexAutoAttendants",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"get",
"clone",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "locationName",
"title": "locationName"
},
{
"name": "phoneNumber",
"title": "Phone Number"
},
{
"name": "extension",
"title": "Extension"
},
{
"name": "tollFreeNumber",
"title": "Toll Free Number"
},
{
"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/WebexAutoAttendants/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebexAutoAttendants/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/WebexAutoAttendants/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/WebexAutoAttendants/?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/WebexAutoAttendants; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexAutoAttendants/[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/WebexAutoAttendants and the JSON format can be used to import instances of relation/WebexAutoAttendants.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexAutoAttendants/[pkid] | hierarchy=[hierarchy] | The relation/WebexAutoAttendants instance with [pkid]. |