[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": {
"aa_id": {
"title": "aa_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": "locationName",
"type": "string"
},
"name": {
"title": "Name",
"type": "string",
"required": true
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"phoneNumber": {
"title": "Phone Number",
"type": "string"
},
"extension": {
"title": "Extension",
"type": "string"
},
"tollFreeNumber": {
"title": "Toll Free Number",
"type": "boolean",
"description": "Flag to indicate if auto attendant number is toll-free number"
},
"firstName": {
"title": "First Name",
"type": "string",
"required": true
},
"lastName": {
"title": "Last Name",
"type": "string",
"required": true
},
"alternateNumbers": {
"type": "array",
"title": "Alternate Numbers",
"items": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "phoneNumber"
},
"ringPattern": {
"type": "string",
"title": "Ring Pattern",
"description": "ringPattern",
"required": true,
"choices": [
{
"title": "NORMAL",
"value": "NORMAL"
},
{
"title": "LONG_LONG",
"value": "LONG_LONG"
},
{
"title": "SHORT_SHORT_LONG",
"value": "SHORT_SHORT_LONG"
},
{
"title": "SHORT_LONG_SHORT",
"value": "SHORT_LONG_SHORT"
}
]
},
"tollFreeNumber": {
"type": "boolean",
"title": "TollFree Number",
"description": "tollFreeNumber"
}
}
}
},
"language": {
"title": "Language",
"type": "string",
"required": true
},
"languageCode": {
"title": "Language Code",
"type": "string"
},
"businessSchedule": {
"title": "Business Hours Schedule",
"type": "string",
"required": true,
"description": "Business hours defined for the auto attendant"
},
"holidaySchedule": {
"title": "Holiday Schedule",
"type": "string",
"description": "Holiday defined for the auto attendant"
},
"extensionDialing": {
"title": "Extension Dialing",
"type": "string",
"enum": [
"ENTERPRISE",
"GROUP"
],
"description": "Extension dialing setting. If the values are not set default will be set as ENTERPRISE",
"choices": [
{
"title": "ENTERPRISE",
"value": "ENTERPRISE"
},
{
"title": "GROUP",
"value": "GROUP"
}
]
},
"nameDialing": {
"title": "Name Dialing",
"type": "string",
"enum": [
"ENTERPRISE",
"GROUP"
],
"description": "Name dialing setting. If the values are not set default will be set as ENTERPRISE",
"choices": [
{
"title": "ENTERPRISE",
"value": "ENTERPRISE"
},
{
"title": "GROUP",
"value": "GROUP"
}
]
},
"timeZone": {
"title": "Time Zone",
"type": "string"
},
"businessHoursMenu": {
"title": "Business Hours Menu",
"description": "Business hours menu defined for the auto attendant",
"required": true,
"type": "object",
"properties": {
"greeting": {
"title": "Greeting",
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"choices": [
{
"title": "DEFAULT",
"value": "DEFAULT"
},
{
"title": "CUSTOM",
"value": "CUSTOM"
}
]
},
"audioAnnouncementFile": {
"title": "Greeting File",
"description": "Announcement Audio File details",
"required": false,
"type": "object",
"properties": {
"level": {
"title": "Level",
"type": "string",
"description": "Audio announcement file type location",
"enum": [
"ORGANIZATION",
"LOCATION"
],
"choices": [
{
"title": "Enterprise",
"value": "ORGANIZATION"
},
{
"title": "Location",
"value": "LOCATION"
}
]
},
"id": {
"title": "Name",
"type": "string",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/Announcements",
"choices": []
},
"fileName": {
"title": "File Name",
"type": "string",
"readonly": true
},
"mediaFileType": {
"title": "File Type",
"type": "string",
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
]
}
}
},
"extensionEnabled": {
"title": "Extension Dialing",
"type": "boolean",
"description": "Enable extension dialling without requiring a menu item"
},
"keyConfigurations": {
"title": "Key Configurations",
"description": "Key configurations defined for the auto attendant",
"required": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"title": "Key",
"type": "string",
"description": "Key assigned to specific menu configuration",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"#"
],
"choices": [
{
"title": "0",
"value": "0"
},
{
"title": "1",
"value": "1"
},
{
"title": "2",
"value": "2"
},
{
"title": "3",
"value": "3"
},
{
"title": "4",
"value": "4"
},
{
"title": "5",
"value": "5"
},
{
"title": "6",
"value": "6"
},
{
"title": "7",
"value": "7"
},
{
"title": "8",
"value": "8"
},
{
"title": "9",
"value": "9"
},
{
"title": "#",
"value": "#"
},
{
"title": "*",
"value": "*"
}
]
},
"action": {
"title": "Action",
"type": "string",
"description": "Action assigned to specific menu key configuration",
"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"
],
"choices": [
{
"title": "Play announcement",
"value": "PLAY_ANNOUNCEMENT"
},
{
"title": "Transfer call with prompt",
"value": "TRANSFER_WITH_PROMPT"
},
{
"title": "Transfer call without prompt",
"value": "TRANSFER_WITHOUT_PROMPT"
},
{
"title": "Transfer call to operator",
"value": "TRANSFER_TO_OPERATOR"
},
{
"title": "Transfer to voicemail",
"value": "TRANSFER_TO_MAILBOX"
},
{
"title": "Dial by name",
"value": "NAME_DIALING"
},
{
"title": "Dial by extension",
"value": "EXTENSION_DIALING"
},
{
"title": "Repeat menu",
"value": "REPEAT_MENU"
},
{
"title": "Exit Menu",
"value": "EXIT"
}
]
},
"key_description": {
"title": "Description",
"description": "Provide a label for this menu option",
"type": "string"
},
"value": {
"title": "Phone Number or Extension",
"type": "string"
},
"audioAnnouncementFile": {
"title": "Announcement File",
"description": "Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set",
"required": false,
"type": "object",
"properties": {
"level": {
"title": "Level",
"type": "string",
"description": "Audio announcement file type location",
"enum": [
"ORGANIZATION",
"LOCATION"
],
"choices": [
{
"title": "Enterprise",
"value": "ORGANIZATION"
},
{
"title": "Location",
"value": "LOCATION"
}
]
},
"id": {
"title": "Name",
"type": "string",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/Announcements",
"choices": []
},
"fileName": {
"title": "File Name",
"type": "string",
"readonly": true
},
"mediaFileType": {
"title": "File Type",
"type": "string",
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
]
}
}
}
}
}
}
}
},
"afterHoursMenu": {
"title": "After Hours Menu",
"description": "After hours menu defined for the auto attendant",
"required": true,
"type": "object",
"properties": {
"greeting": {
"title": "Greeting",
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"choices": [
{
"title": "DEFAULT",
"value": "DEFAULT"
},
{
"title": "CUSTOM",
"value": "CUSTOM"
}
]
},
"audioAnnouncementFile": {
"title": "Greeting File",
"description": "Announcement Audio File details",
"required": false,
"type": "object",
"properties": {
"level": {
"title": "Level",
"type": "string",
"description": "Audio announcement file type location",
"enum": [
"ORGANIZATION",
"LOCATION"
],
"choices": [
{
"title": "Enterprise",
"value": "ORGANIZATION"
},
{
"title": "Location",
"value": "LOCATION"
}
]
},
"id": {
"title": "Name",
"type": "string",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/Announcements",
"choices": []
},
"fileName": {
"title": "File Name",
"type": "string",
"readonly": true
},
"mediaFileType": {
"title": "File Type",
"type": "string",
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
]
}
}
},
"extensionEnabled": {
"title": "Extension Dialing",
"type": "boolean",
"description": "Enable extension dialling without requiring a menu item"
},
"keyConfigurations": {
"title": "Key Configurations",
"description": "Key configurations defined for the auto attendant",
"required": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"title": "Key",
"type": "string",
"description": "Key assigned to specific menu configuration",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"#"
],
"choices": [
{
"title": "0",
"value": "0"
},
{
"title": "1",
"value": "1"
},
{
"title": "2",
"value": "2"
},
{
"title": "3",
"value": "3"
},
{
"title": "4",
"value": "4"
},
{
"title": "5",
"value": "5"
},
{
"title": "6",
"value": "6"
},
{
"title": "7",
"value": "7"
},
{
"title": "8",
"value": "8"
},
{
"title": "9",
"value": "9"
},
{
"title": "#",
"value": "#"
}
]
},
"action": {
"title": "Action",
"type": "string",
"description": "Action assigned to specific menu key configuration",
"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"
],
"choices": [
{
"title": "Play announcement",
"value": "PLAY_ANNOUNCEMENT"
},
{
"title": "Transfer call with prompt",
"value": "TRANSFER_WITH_PROMPT"
},
{
"title": "Transfer call without prompt",
"value": "TRANSFER_WITHOUT_PROMPT"
},
{
"title": "Transfer call to operator",
"value": "TRANSFER_TO_OPERATOR"
},
{
"title": "Transfer to voicemail",
"value": "TRANSFER_TO_MAILBOX"
},
{
"title": "Dial by name",
"value": "NAME_DIALING"
},
{
"title": "Dial by extension",
"value": "EXTENSION_DIALING"
},
{
"title": "Repeat menu",
"value": "REPEAT_MENU"
},
{
"title": "Exit Menu",
"value": "EXIT"
}
]
},
"key_description": {
"title": "Description",
"description": "Provide a label for this menu option",
"type": "string"
},
"value": {
"title": "Phone Number or Extension",
"type": "string"
},
"audioAnnouncementFile": {
"title": "Announcement File",
"description": "Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set",
"required": false,
"type": "object",
"properties": {
"level": {
"title": "Level",
"type": "string",
"description": "Audio announcement file type location",
"enum": [
"ORGANIZATION",
"LOCATION"
],
"choices": [
{
"title": "Enterprise",
"value": "ORGANIZATION"
},
{
"title": "Location",
"value": "LOCATION"
}
]
},
"id": {
"title": "Name",
"type": "string",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/Announcements",
"choices": []
},
"fileName": {
"title": "File Name",
"type": "string",
"readonly": true
},
"mediaFileType": {
"title": "File Type",
"type": "string",
"readonly": true,
"enum": [
"WAV",
"WMA",
"3GP"
]
}
}
}
}
}
}
}
},
"callForwarding": {
"title": "Call Forwarding Settings",
"description": "Call Forwarding Settings",
"required": false,
"type": "object",
"properties": {
"always": {
"title": "Always",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"ringReminderEnabled": {
"type": "boolean",
"title": "Ring Reminder Enabled",
"description": "ringReminderEnabled"
},
"destinationVoiceMailEnabled": {
"type": "boolean",
"title": "Send To Voicemail Enabled",
"description": "destinationVoiceMailEnabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
}
}
},
"selective": {
"title": "Selective",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"ringReminderEnabled": {
"type": "boolean",
"title": "Ring Reminder Enabled",
"description": "ringReminderEnabled"
},
"destinationVoiceMailEnabled": {
"type": "boolean",
"title": "Send To Voicemail Enabled",
"description": "destinationVoiceMailEnabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
}
}
},
"rules": {
"title": "Rules",
"description": "rules",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "name"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"id": {
"type": "string",
"title": "id",
"description": "id"
},
"holidaySchedule": {
"type": "string",
"title": "Holiday Schedule",
"description": "holidaySchedule"
},
"businessSchedule": {
"type": "string",
"title": "Business Schedule",
"description": "businessSchedule"
},
"forwardTo": {
"type": "object",
"title": "Forward To",
"description": "forwardTo",
"properties": {
"selection": {
"type": "string",
"title": "Selection",
"description": "selection",
"choices": [
{
"title": "FORWARD_TO_DEFAULT_NUMBER",
"value": "FORWARD_TO_DEFAULT_NUMBER"
},
{
"title": "FORWARD_TO_SPECIFIED_NUMBER",
"value": "FORWARD_TO_SPECIFIED_NUMBER"
},
{
"title": "DO_NOT_FORWARD",
"value": "DO_NOT_FORWARD"
}
]
},
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "phoneNumber"
}
}
},
"callsFrom": {
"type": "object",
"title": "Calls From",
"description": "callsFrom",
"properties": {
"selection": {
"type": "string",
"title": "Selection",
"description": "selection",
"choices": [
{
"title": "ANY",
"value": "ANY"
},
{
"title": "CUSTOM",
"value": "CUSTOM"
}
]
},
"customNumbers": {
"type": "object",
"title": "Custom Numbers",
"description": "customNumbers",
"properties": {
"privateNumberEnabled": {
"type": "boolean",
"title": "Any Private Numbers ",
"description": "privateNumberEnabled"
},
"unavailableNumberEnabled": {
"type": "boolean",
"title": "Any Unavailable Numbers",
"description": "unavailableNumberEnabled"
},
"numbers": {
"type": "array",
"title": "Numbers",
"items": {
"type": "string"
}
}
}
}
}
},
"callsTo": {
"type": "object",
"title": "Calls To",
"description": "callsTo",
"properties": {
"numbers": {
"title": "Calls To Numbers",
"description": "Array of numbers to be matched against the calling destination number",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary or alternate number",
"choices": [
{
"title": "PRIMARY",
"value": "PRIMARY"
},
{
"title": "ALTERNATE",
"value": "ALTERNATE"
}
]
},
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "Only return call queues with matching primary phone number or extension"
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Primary phone extension of the call queue."
}
}
}
}
}
}
}
}
}
}
},
"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/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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/WebexAutoAttendants/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"remove",
"help",
"add",
"configuration_template",
"export",
"list",
"get",
"bulk_update",
"clone",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/WebexAutoAttendants",
"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"
},
{
"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/WebexAutoAttendants/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"add",
"configuration_template",
"export",
"list",
"get",
"clone",
"export_bulkload_template"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/WebexAutoAttendants/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/WebexAutoAttendants/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/WebexAutoAttendants/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/WebexAutoAttendants/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/WebexAutoAttendants/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/WebexAutoAttendants/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"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]. |