[Index]
Webex Workspace Call Settings
Model ref.: relation/WebexWorkspaceCallSettings
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": {
"id": {
"readonly": true,
"title": "Id",
"type": "string"
},
"locationId": {
"readonly": true,
"title": "Location ID",
"type": "string"
},
"locationName": {
"title": "Location Name",
"readonly": true,
"type": "string",
"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": []
},
"displayName": {
"readonly": true,
"required": true,
"title": "Name",
"description": "A friendly name for the workspace.",
"type": "string"
},
"calling": {
"title": "Calling",
"type": "object",
"readonly": true,
"properties": {
"type": {
"type": "string",
"name": "type",
"readonly": true,
"default": "freeCalling",
"description": "This determines how calls are made from this place.",
"title": "Calling Behaviour",
"choices": [
{
"value": "none",
"title": "No Calling"
},
{
"value": "freeCalling",
"title": "Free Calling (default)"
},
{
"value": "webexCalling",
"title": "Webex Calling"
},
{
"value": "thirdPartySipCalling",
"title": "Third-party SIP URI"
},
{
"value": "webexEdgeForDevices",
"title": "Webex Edge For Devices"
}
]
}
}
},
"callerId": {
"title": "CallerID",
"description": "Retrieve Caller ID Settings for a Workspace. Caller ID settings control how a workspace's information is displayed when making outgoing calls.",
"required": false,
"type": "object",
"properties": {
"selected": {
"title": "Caller ID Type",
"description": "Which type of outgoing Caller ID will be used.",
"type": "string",
"choices": [
{
"value": "DIRECT_LINE",
"title": "DIRECT_LINE"
},
{
"value": "LOCATION_NUMBER",
"title": "LOCATION_NUMBER"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
]
},
"directNumber": {
"title": "Direct Number",
"description": "Direct number which will be shown if DIRECT_LINE is selected.",
"type": "string"
},
"locationNumber": {
"title": "Location Number",
"description": "Location number which will be shown if LOCATION_NUMBER is selected.",
"type": "string"
},
"tollFreeLocationNumber": {
"title": "Toll Free Location Number",
"description": "Flag for specifying a toll-free number.",
"type": "boolean"
},
"customNumber": {
"title": "Custom Number",
"description": "This value must be an assigned number from the person's location.",
"type": "string"
},
"displayName": {
"title": "Display Name",
"description": "Workspace's caller ID display name.",
"type": "string"
},
"displayDetail": {
"title": "Display Detail",
"description": "Workspace's caller ID display details. Default is ..",
"type": "string"
},
"blockInForwardCallsEnabled": {
"title": "Block Call Forwarding",
"description": "Flag to block call forwarding.",
"type": "boolean"
},
"externalCallerIdNamePolicy": {
"title": "External Caller Id Name Policy",
"description": "Designates which type of External Caller ID Name policy is used.",
"type": "string",
"choices": [
{
"value": "DIRECT_LINE",
"title": "DIRECT_LINE"
},
{
"value": "LOCATION",
"title": "LOCATION"
},
{
"value": "OTHER",
"title": "OTHER"
}
]
},
"customExternalCallerIdName": {
"title": "Custom External Caller Id Name",
"description": "Custom External Caller Name, which will be shown if External Caller ID Name is OTHER.",
"type": "string"
},
"locationExternalCallerIdName": {
"title": "Location External Caller Id Name",
"description": "The display name for location caller id",
"type": "string"
}
}
},
"callForwarding": {
"title": "Call Forwarding",
"description": "call forwarding",
"required": false,
"type": "object",
"properties": {
"businessContinuity": {
"title": "Business Continuity",
"description": "Forward calls if the network is disconnected.",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Business Continuity call forwarding is enabled or disabled."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "Destination for Business Continuity call forwarding."
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "Destination for Business Continuity call forwarding."
}
}
},
"callForwarding": {
"description": "Call forwarding settings for a Workspace.",
"title": "Call Forwarding",
"type": "object",
"properties": {
"busy": {
"title": "Busy",
"description": "Busy call forwarding setting.",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Busy call forwarding is enabled or disabled."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "Destination for Busy call forwarding."
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "Destination for Busy call forwarding."
}
}
},
"noAnswer": {
"title": "No Answer",
"description": "No Answer Call Forward Settings.",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "No Answer call forwarding is enabled or disabled."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "Destination for No Answer call forwarding."
},
"numberOfRings": {
"type": "integer",
"title": "Number Of Rings",
"description": "Destination for No Answer call forwarding."
},
"systemMaxNumberOfRings": {
"type": "integer",
"title": "System Max Number Of Rings",
"description": "Destination for No Answer call forwarding."
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "Destination for No Answer call forwarding."
}
}
},
"always": {
"title": "Always",
"description": "Call Forward All Settings",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Call Forward All call forwarding is enabled or disabled."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "Destination for No Answer call forwarding."
},
"ringReminderEnabled": {
"type": "boolean",
"title": "Ring Reminder Enabled",
"description": "Call Forward All Ring Reminder Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "Destination for Call Forward All call forwarding."
}
}
}
}
}
}
},
"callWaiting": {
"description": "Call forwarding settings for a Workspace.",
"title": "Call Waiting",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Call Waiting state."
}
}
},
"callMonitoring": {
"title": "Call Monitoring",
"description": "Call Monitoring Settings",
"required": false,
"type": "object",
"properties": {
"callParkNotificationEnabled": {
"type": "boolean",
"title": "Call Park Notification Enabled",
"description": "Call park notification enabled or disabled."
},
"callPark": {
"title": "Call Park Extension",
"description": "Monitored call Park element items",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of call park extension."
},
"id": {
"type": "string",
"title": "ID",
"description": "ID of call park extension."
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Extension of call park extension."
},
"location": {
"type": "string",
"title": "Location Name",
"description": "Name of location for call park extension."
},
"locationId": {
"type": "string",
"title": "Location ID",
"description": "ID of location for call park extension."
}
}
}
},
"member": {
"title": "Member Extension",
"description": "Monitored Member Line Extensions",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"title": "Email",
"description": "Email of the person or workspace."
},
"id": {
"type": "string",
"title": "ID",
"description": "ID of person or workspace."
},
"firstName": {
"type": "string",
"title": "First Name",
"description": "First name of person or workspace"
},
"lastName": {
"type": "string",
"title": "Last Name",
"description": "Last name of person or workspace"
},
"displayName": {
"type": "string",
"title": "Display Name",
"description": "Display name of person or workspace"
},
"type": {
"type": "string",
"title": "Type",
"description": "Type of the person or workspace.",
"choices": [
{
"value": "PEOPLE",
"title": "PEOPLE"
},
{
"value": "PLACE",
"title": "PLACE"
}
]
},
"location": {
"type": "string",
"title": "Location",
"description": "Name of location for call park."
},
"locationId": {
"type": "string",
"title": "Location ID",
"description": "ID of the location for call park."
},
"numbers": {
"description": "List of phone numbers of the person or workspace.",
"title": "Numbers",
"type": "array",
"items": {
"type": "object",
"properties": {
"external": {
"type": "string",
"title": "External",
"description": "Phone number of person or workspace. Either phoneNumber or extension is mandatory."
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Extension of person or workspace. Either phoneNumber or extension is mandatory."
},
"primary": {
"type": "boolean",
"title": "Primary",
"description": "Flag to indicate primary phone."
},
"tollFreeNumber": {
"type": "boolean",
"title": "Toll Free Number",
"description": "Flag to indicate toll free number."
}
}
}
}
}
}
}
}
},
"workspaceNumbers": {
"title": "Workspace Numbers",
"description": "List numbers for this workspace.",
"required": false,
"type": "object",
"properties": {
"phoneNumbers": {
"title": "Phone Numbers",
"description": "Array of numbers primary followed by alternate numbers.",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"external": {
"type": "string",
"title": "External",
"description": "PSTN phone number in E.164 format."
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Extension for workspace."
},
"primary": {
"type": "boolean",
"title": "Primary",
"description": "Name of location for call park extension."
}
}
}
}
},
"workspace": {
"title": "Workspace",
"description": "Workspace object having a unique identifier for the Workspace.",
"required": false,
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "ID of person or workspace."
}
}
},
"location": {
"title": "Location",
"description": "Location object having a unique identifier for the location and its name.",
"required": false,
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Location identifier associated with the workspace."
},
"name": {
"type": "string",
"title": "Name",
"description": "Location name associated with the workspace."
}
}
},
"organization": {
"title": "Organization",
"description": "Organization object having a unique identifier for the organization and its name.",
"required": false,
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Organization identifier associated with the workspace."
},
"name": {
"type": "string",
"title": "Name",
"description": "Organization name associated with the workspace."
}
}
}
},
"incomingPermission": {
"title": "Incoming Permission",
"description": "Retrieve Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.",
"required": false,
"type": "object",
"properties": {
"useCustomEnabled": {
"type": "boolean",
"title": "Use Custom Enabled",
"description": "Incoming Permission state. If disabled, the default settings are used."
},
"externalTransfer": {
"type": "string",
"title": "External Transfer",
"description": "Indicate call transfer setting.",
"choices": [
{
"value": "ALLOW_ALL_EXTERNAL",
"title": "ALLOW_ALL_EXTERNAL"
},
{
"value": "ALLOW_ONLY_TRANSFERRED_EXTERNAL",
"title": "ALLOW_ONLY_TRANSFERRED_EXTERNAL"
},
{
"value": "BLOCK_ALL_EXTERNAL",
"title": "BLOCK_ALL_EXTERNAL"
}
]
},
"internalCallsEnabled": {
"type": "boolean",
"title": "Internal Calls Enabled",
"description": "Flag to indicate if workspace can receive internal calls."
},
"collectCallsEnabled": {
"type": "boolean",
"title": "Collect Calls Enabled",
"description": "Flag to indicate if workspace can receive collect calls."
}
}
},
"outgoingPermissions": {
"title": "Outgoing Permissions",
"description": "A location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.",
"required": false,
"type": "object",
"properties": {
"useCustomEnabled": {
"type": "boolean",
"title": "Use Custom Enabled",
"description": "Incoming Permission state. If disabled, the default settings are used."
},
"callingPermissions": {
"description": "Workspace calling permissions settings.",
"title": "Calling Permissions",
"type": "array",
"items": {
"type": "object",
"properties": {
"callType": {
"type": "string",
"title": "Call Type",
"custom_value_allowed": true,
"description": "Call Type Values",
"choices": [
{
"value": "INTERNAL_CALL",
"title": "INTERNAL_CALL"
},
{
"value": "TOLL_FREE",
"title": "TOLL_FREE"
},
{
"value": "INTERNATIONAL",
"title": "INTERNATIONAL"
},
{
"value": "OPERATOR_ASSISTED",
"title": "OPERATOR_ASSISTED"
},
{
"value": "CHARGEABLE_DIRECTORY_ASSISTED",
"title": "CHARGEABLE_DIRECTORY_ASSISTED"
},
{
"value": "SPECIAL_SERVICES_I",
"title": "SPECIAL_SERVICES_I"
},
{
"value": "SPECIAL_SERVICES_II",
"title": "SPECIAL_SERVICES_II"
},
{
"value": "PREMIUM_SERVICES_I",
"title": "PREMIUM_SERVICES_I"
},
{
"value": "PREMIUM_SERVICES_II",
"title": "PREMIUM_SERVICES_II"
},
{
"value": "NATIONAL",
"title": "NATIONAL"
}
]
},
"action": {
"type": "string",
"title": "Action",
"description": "Allows to configure settings for each call type.",
"choices": [
{
"value": "ALLOW",
"title": "ALLOW"
},
{
"value": "BLOCK",
"title": "BLOCK"
},
{
"value": "AUTH_CODE",
"title": "AUTH_CODE"
},
{
"value": "TRANSFER_NUMBER_1",
"title": "TRANSFER_NUMBER_1"
},
{
"value": "TRANSFER_NUMBER_2",
"title": "TRANSFER_NUMBER_2"
},
{
"value": "TRANSFER_NUMBER_2",
"title": "TRANSFER_NUMBER_2"
}
]
},
"transferEnabled": {
"type": "boolean",
"title": "Transfer Enabled",
"description": "If enabled, allow the person to transfer or forward internal calls."
}
}
}
}
}
},
"accessCodes": {
"title": "Access Codes",
"description": "Retrieve Access codes for a Workspace. Access codes are used to bypass permissions.",
"required": false,
"type": "object",
"properties": {
"accessCodes": {
"description": "Access Codes",
"title": "Access Codes",
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"custom_value_allowed": true,
"description": "Indicates an access code."
},
"description": {
"type": "string",
"title": "Description",
"custom_value_allowed": true,
"description": "Indicates the description of the access code."
}
}
}
}
}
},
"callIntercept": {
"title": "Call Intercept",
"description": "Retrieves Workspace's Call Intercept Settings.",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "True if call intercept is enabled."
},
"incoming": {
"title": "Incoming",
"description": "Settings related to how incoming calls are handled when the intercept feature is enabled.",
"required": false,
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type",
"custom_value_allowed": true,
"description": "Indicated incoming calls are intercepted.",
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_ALL",
"title": "ALLOW_ALL"
}
]
},
"voicemailEnabled": {
"type": "boolean",
"title": "Voicemail Enabled",
"description": "Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled."
},
"announcements": {
"description": "Settings related to how incoming calls are handled when the intercept feature is enabled.",
"title": "Announcements",
"type": "object",
"properties": {
"greeting": {
"type": "string",
"title": "Greeting",
"description": "Indicates that a system default message will be placed when incoming calls are intercepted.",
"choices": [
{
"value": "CUSTOM",
"title": "CUSTOM"
},
{
"value": "DEFAULT",
"title": "DEFAULT"
}
]
},
"filename": {
"type": "string",
"title": "Filename",
"custom_value_allowed": true,
"description": "Filename of the custom greeting; this is an empty string if no custom greeting has been uploaded."
},
"newNumber": {
"description": "Information about the new number announcement.",
"title": "New Number",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If true, the caller hears this new number when the call is intercepted."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "New number the caller hears announced."
}
}
},
"zeroTransfer": {
"description": "Information about how the call will be handled if zero 0 is pressed.",
"title": "Zero Transfer",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If true, the caller hears this new number when the call is intercepted."
},
"destination": {
"type": "string",
"title": "Destination",
"description": "New number the caller hears announced."
}
}
}
}
}
}
},
"outgoing": {
"title": "outgoing",
"description": "Settings related to how outgoing calls are handled when the intercept feature is enabled.",
"required": false,
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type",
"custom_value_allowed": true,
"description": "Indicated outgoing calls are intercepted.",
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_ALL",
"title": "ALLOW_ALL"
}
]
},
"transferEnabled": {
"type": "boolean",
"title": "Transfer Enabled",
"description": "If true, when the person attempts to make an outbound call, a system default message is played and the call is made to the destination phone number."
},
"destination": {
"type": "string",
"title": "Destination",
"custom_value_allowed": true,
"description": "Number to which the outbound call be transferred."
}
}
}
}
},
"transferNumbers": {
"title": "Auto Transfer Numbers",
"description": "Retrieve Transfer Numbers Settings for a Workspace. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. ",
"required": false,
"type": "object",
"properties": {
"autoTransferNumber1": {
"type": "string",
"title": "Auto Transfer Number 1",
"custom_value_allowed": true,
"description": "When calling a specific call type, this workspace will be automatically transferred to another number."
},
"autoTransferNumber2": {
"type": "string",
"title": "Auto Transfer Number 2",
"custom_value_allowed": true,
"description": "When calling a specific call type, this workspace will be automatically transferred to another number."
},
"autoTransferNumber3": {
"type": "string",
"title": "Auto Transfer Number 3",
"custom_value_allowed": true,
"description": "When calling a specific call type, this workspace will be automatically transferred to another number."
}
}
},
"NoInstance": {
"title": "No Instance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
}
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexWorkspaceCallSettings/add/ |
|
The GUI Add form of relation/WebexWorkspaceCallSettings 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/WebexWorkspaceCallSettings | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexWorkspaceCallSettings; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexWorkspaceCallSettings/export/ |
|
{ "hrefs":["/api/relation/WebexWorkspaceCallSettings/[pkid1]", "/api/relation/WebexWorkspaceCallSettings/[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/WebexWorkspaceCallSettings and the JSON format can be used to import instances of relation/WebexWorkspaceCallSettings.
GET http://[host-proxy]/api/relation/WebexWorkspaceCallSettings/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebexWorkspaceCallSettings | POST | /api/relation/WebexWorkspaceCallSettings/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexWorkspaceCallSettings/ |
|
The relation/WebexWorkspaceCallSettings schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexWorkspaceCallSettings instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "displayName",
"direction": "asc",
"current": "/api/relation/WebexWorkspaceCallSettings/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/WebexWorkspaceCallSettings",
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "calling.type",
"title": "Calling Behaviour",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "locationName",
"title": "Location Name"
},
{
"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/WebexWorkspaceCallSettings/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "1.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/WebexWorkspaceCallSettings/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/WebexWorkspaceCallSettings/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/WebexWorkspaceCallSettings/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/WebexWorkspaceCallSettings/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/WebexWorkspaceCallSettings/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebexWorkspaceCallSettings; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexWorkspaceCallSettings/[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/WebexWorkspaceCallSettings and the JSON format can be used to import instances of relation/WebexWorkspaceCallSettings.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexWorkspaceCallSettings/[pkid] | hierarchy=[hierarchy] | The relation/WebexWorkspaceCallSettings instance with [pkid]. |