[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": {
"incomingPermission": {
"properties": {
"internalCallsEnabled": {
"type": "boolean",
"description": "Flag to indicate if workspace can receive internal calls.",
"title": "Internal Calls Enabled"
},
"useCustomEnabled": {
"type": "boolean",
"description": "Incoming Permission state. If disabled, the default settings are used.",
"title": "Use Custom Enabled"
},
"externalTransfer": {
"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"
}
],
"type": "string",
"description": "Indicate call transfer setting.",
"title": "External Transfer"
},
"collectCallsEnabled": {
"type": "boolean",
"description": "Flag to indicate if workspace can receive collect calls.",
"title": "Collect Calls Enabled"
}
},
"required": false,
"type": "object",
"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.",
"title": "Incoming Permission"
},
"displayName": {
"readonly": true,
"required": true,
"type": "string",
"description": "A friendly name for the workspace.",
"title": "Name"
},
"callerId": {
"properties": {
"customNumber": {
"type": "string",
"description": "This value must be an assigned number from the person's location.",
"title": "Custom Number"
},
"displayDetail": {
"type": "string",
"description": "Workspace's caller ID display details. Default is ..",
"title": "Display Detail"
},
"customExternalCallerIdName": {
"type": "string",
"description": "Custom External Caller Name, which will be shown if External Caller ID Name is OTHER.",
"title": "Custom External Caller Id Name"
},
"selected": {
"choices": [
{
"value": "DIRECT_LINE",
"title": "DIRECT_LINE"
},
{
"value": "LOCATION_NUMBER",
"title": "LOCATION_NUMBER"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"type": "string",
"description": "Which type of outgoing Caller ID will be used.",
"title": "Caller ID Type"
},
"locationNumber": {
"type": "string",
"description": "Location number which will be shown if LOCATION_NUMBER is selected.",
"title": "Location Number"
},
"tollFreeLocationNumber": {
"type": "boolean",
"description": "Flag for specifying a toll-free number.",
"title": "Toll Free Location Number"
},
"blockInForwardCallsEnabled": {
"type": "boolean",
"description": "Flag to block call forwarding.",
"title": "Block Call Forwarding"
},
"directNumber": {
"type": "string",
"description": "Direct number which will be shown if DIRECT_LINE is selected.",
"title": "Direct Number"
},
"locationExternalCallerIdName": {
"type": "string",
"description": "The display name for location caller id",
"title": "Location External Caller Id Name"
},
"externalCallerIdNamePolicy": {
"choices": [
{
"value": "DIRECT_LINE",
"title": "DIRECT_LINE"
},
{
"value": "LOCATION",
"title": "LOCATION"
},
{
"value": "OTHER",
"title": "OTHER"
}
],
"type": "string",
"description": "Designates which type of External Caller ID Name policy is used.",
"title": "External Caller Id Name Policy"
}
},
"required": false,
"type": "object",
"description": "Retrieve Caller ID Settings for a Workspace. Caller ID settings control how a workspace's information is displayed when making outgoing calls.",
"title": "CallerID"
},
"callIntercept": {
"properties": {
"incoming": {
"properties": {
"announcements": {
"properties": {
"newNumber": {
"properties": {
"destination": {
"type": "string",
"description": "New number the caller hears announced.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "If true, the caller hears this new number when the call is intercepted.",
"title": "Enabled"
}
},
"type": "object",
"description": "Information about the new number announcement.",
"title": "New Number"
},
"zeroTransfer": {
"properties": {
"destination": {
"type": "string",
"description": "New number the caller hears announced.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "If true, the caller hears this new number when the call is intercepted.",
"title": "Enabled"
}
},
"type": "object",
"description": "Information about how the call will be handled if zero 0 is pressed.",
"title": "Zero Transfer"
},
"greeting": {
"choices": [
{
"value": "CUSTOM",
"title": "CUSTOM"
},
{
"value": "DEFAULT",
"title": "DEFAULT"
}
],
"type": "string",
"description": "Indicates that a system default message will be placed when incoming calls are intercepted.",
"title": "Greeting"
},
"filename": {
"custom_value_allowed": true,
"type": "string",
"description": "Filename of the custom greeting; this is an empty string if no custom greeting has been uploaded.",
"title": "Filename"
}
},
"type": "object",
"description": "Settings related to how incoming calls are handled when the intercept feature is enabled.",
"title": "Announcements"
},
"type": {
"custom_value_allowed": true,
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_ALL",
"title": "ALLOW_ALL"
}
],
"type": "string",
"description": "Indicated incoming calls are intercepted.",
"title": "Type"
},
"voicemailEnabled": {
"type": "boolean",
"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.",
"title": "Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "Settings related to how incoming calls are handled when the intercept feature is enabled.",
"title": "Incoming"
},
"outgoing": {
"properties": {
"destination": {
"custom_value_allowed": true,
"type": "string",
"description": "Number to which the outbound call be transferred.",
"title": "Destination"
},
"type": {
"custom_value_allowed": true,
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_ALL",
"title": "ALLOW_ALL"
}
],
"type": "string",
"description": "Indicated outgoing calls are intercepted.",
"title": "Type"
},
"transferEnabled": {
"type": "boolean",
"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.",
"title": "Transfer Enabled"
}
},
"required": false,
"type": "object",
"description": "Settings related to how outgoing calls are handled when the intercept feature is enabled.",
"title": "outgoing"
},
"enabled": {
"type": "boolean",
"description": "True if call intercept is enabled.",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Retrieves Workspace's Call Intercept Settings.",
"title": "Call Intercept"
},
"workspaceNumbers": {
"description": "List numbers for this workspace.",
"title": "Workspace Numbers",
"required": false,
"location": {
"properties": {
"id": {
"type": "string",
"description": "Location identifier associated with the workspace.",
"title": "ID"
},
"name": {
"type": "string",
"description": "Location name associated with the workspace.",
"title": "Name"
}
},
"required": false,
"type": "object",
"description": "Location object having a unique identifier for the location and its name.",
"title": "Location"
},
"workspace": {
"properties": {
"id": {
"type": "string",
"description": "ID of person or workspace.",
"title": "ID"
}
},
"required": false,
"type": "object",
"description": "Workspace object having a unique identifier for the Workspace.",
"title": "Workspace"
},
"organization": {
"properties": {
"id": {
"type": "string",
"description": "Organization identifier associated with the workspace.",
"title": "ID"
},
"name": {
"type": "string",
"description": "Organization name associated with the workspace.",
"title": "Name"
}
},
"required": false,
"type": "object",
"description": "Organization object having a unique identifier for the organization and its name.",
"title": "Organization"
},
"type": "object",
"properties": {
"phoneNumbers": {
"items": {
"type": "object",
"properties": {
"external": {
"type": "string",
"description": "PSTN phone number in E.164 format.",
"title": "External"
},
"extension": {
"type": "string",
"description": "Extension for workspace.",
"title": "Extension"
},
"primary": {
"type": "boolean",
"description": "Name of location for call park extension.",
"title": "Primary"
}
}
},
"required": false,
"type": "array",
"description": "Array of numbers primary followed by alternate numbers.",
"title": "Phone Numbers"
}
}
},
"callWaiting": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Call Waiting state.",
"title": "Enabled"
}
},
"type": "object",
"description": "Call forwarding settings for a Workspace.",
"title": "Call Waiting"
},
"callForwarding": {
"properties": {
"businessContinuity": {
"properties": {
"destination": {
"type": "string",
"description": "Destination for Business Continuity call forwarding.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "Business Continuity call forwarding is enabled or disabled.",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Destination for Business Continuity call forwarding.",
"title": "Destination Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "Forward calls if the network is disconnected.",
"title": "Business Continuity"
},
"callForwarding": {
"properties": {
"always": {
"properties": {
"ringReminderEnabled": {
"type": "boolean",
"description": "Call Forward All Ring Reminder Enabled",
"title": "Ring Reminder Enabled"
},
"destination": {
"type": "string",
"description": "Destination for No Answer call forwarding.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "Call Forward All call forwarding is enabled or disabled.",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Destination for Call Forward All call forwarding.",
"title": "Destination Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "Call Forward All Settings",
"title": "Always"
},
"busy": {
"properties": {
"destination": {
"type": "string",
"description": "Destination for Busy call forwarding.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "Busy call forwarding is enabled or disabled.",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Destination for Busy call forwarding.",
"title": "Destination Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "Busy call forwarding setting.",
"title": "Busy"
},
"noAnswer": {
"properties": {
"numberOfRings": {
"type": "integer",
"description": "Destination for No Answer call forwarding.",
"title": "Number Of Rings"
},
"systemMaxNumberOfRings": {
"type": "integer",
"description": "Destination for No Answer call forwarding.",
"title": "System Max Number Of Rings"
},
"destination": {
"type": "string",
"description": "Destination for No Answer call forwarding.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "No Answer call forwarding is enabled or disabled.",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Destination for No Answer call forwarding.",
"title": "Destination Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "No Answer Call Forward Settings.",
"title": "No Answer"
}
},
"type": "object",
"description": "Call forwarding settings for a Workspace.",
"title": "Call Forwarding"
}
},
"required": false,
"type": "object",
"description": "call forwarding",
"title": "Call Forwarding"
},
"callMonitoring": {
"properties": {
"callPark": {
"items": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Name of location for call park extension.",
"title": "Location Name"
},
"locationId": {
"type": "string",
"description": "ID of location for call park extension.",
"title": "Location ID"
},
"name": {
"type": "string",
"description": "Name of call park extension.",
"title": "Name"
},
"extension": {
"type": "string",
"description": "Extension of call park extension.",
"title": "Extension"
},
"id": {
"type": "string",
"description": "ID of call park extension.",
"title": "ID"
}
}
},
"required": false,
"type": "array",
"description": "Monitored call Park element items",
"title": "Call Park Extension"
},
"member": {
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display name of person or workspace",
"title": "Display Name"
},
"firstName": {
"type": "string",
"description": "First name of person or workspace",
"title": "First Name"
},
"lastName": {
"type": "string",
"description": "Last name of person or workspace",
"title": "Last Name"
},
"id": {
"type": "string",
"description": "ID of person or workspace.",
"title": "ID"
},
"locationId": {
"type": "string",
"description": "ID of the location for call park.",
"title": "Location ID"
},
"location": {
"type": "string",
"description": "Name of location for call park.",
"title": "Location"
},
"type": {
"choices": [
{
"value": "PEOPLE",
"title": "PEOPLE"
},
{
"value": "PLACE",
"title": "PLACE"
}
],
"type": "string",
"description": "Type of the person or workspace.",
"title": "Type"
},
"email": {
"type": "string",
"description": "Email of the person or workspace.",
"title": "Email"
},
"numbers": {
"items": {
"type": "object",
"properties": {
"tollFreeNumber": {
"type": "boolean",
"description": "Flag to indicate toll free number.",
"title": "Toll Free Number"
},
"external": {
"type": "string",
"description": "Phone number of person or workspace. Either phoneNumber or extension is mandatory.",
"title": "External"
},
"extension": {
"type": "string",
"description": "Extension of person or workspace. Either phoneNumber or extension is mandatory.",
"title": "Extension"
},
"primary": {
"type": "boolean",
"description": "Flag to indicate primary phone.",
"title": "Primary"
}
}
},
"type": "array",
"description": "List of phone numbers of the person or workspace.",
"title": "Numbers"
}
}
},
"required": false,
"type": "array",
"description": "Monitored Member Line Extensions",
"title": "Member Extension"
},
"callParkNotificationEnabled": {
"type": "boolean",
"description": "Call park notification enabled or disabled.",
"title": "Call Park Notification Enabled"
}
},
"required": false,
"type": "object",
"description": "Call Monitoring Settings",
"title": "Call Monitoring"
},
"outgoingPermissions": {
"properties": {
"useCustomEnabled": {
"type": "boolean",
"description": "Incoming Permission state. If disabled, the default settings are used.",
"title": "Use Custom Enabled"
},
"callingPermissions": {
"items": {
"type": "object",
"properties": {
"callType": {
"custom_value_allowed": true,
"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"
}
],
"type": "string",
"description": "Call Type Values",
"title": "Call Type"
},
"action": {
"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"
}
],
"type": "string",
"description": "Allows to configure settings for each call type.",
"title": "Action"
},
"transferEnabled": {
"type": "boolean",
"description": "If enabled, allow the person to transfer or forward internal calls.",
"title": "Transfer Enabled"
}
}
},
"type": "array",
"description": "Workspace calling permissions settings.",
"title": "Calling Permissions"
}
},
"required": false,
"type": "object",
"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.",
"title": "Outgoing Permissions"
},
"workspaceLocationId": {
"readonly": true,
"type": "string",
"title": "Workspace Location ID"
},
"transferNumbers": {
"properties": {
"autoTransferNumber2": {
"custom_value_allowed": true,
"type": "string",
"description": "When calling a specific call type, this workspace will be automatically transferred to another number.",
"title": "Auto Transfer Number 2"
},
"autoTransferNumber3": {
"custom_value_allowed": true,
"type": "string",
"description": "When calling a specific call type, this workspace will be automatically transferred to another number.",
"title": "Auto Transfer Number 3"
},
"autoTransferNumber1": {
"custom_value_allowed": true,
"type": "string",
"description": "When calling a specific call type, this workspace will be automatically transferred to another number.",
"title": "Auto Transfer Number 1"
}
},
"required": false,
"type": "object",
"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. ",
"title": "Auto Transfer Numbers"
},
"accessCodes": {
"properties": {
"accessCodes": {
"items": {
"type": "object",
"properties": {
"code": {
"custom_value_allowed": true,
"type": "string",
"description": "Indicates an access code.",
"title": "Code"
},
"description": {
"custom_value_allowed": true,
"type": "string",
"description": "Indicates the description of the access code.",
"title": "Description"
}
}
},
"type": "array",
"description": "Access Codes",
"title": "Access Codes"
}
},
"required": false,
"type": "object",
"description": "Retrieve Access codes for a Workspace. Access codes are used to bypass permissions.",
"title": "Access Codes"
},
"calling": {
"readonly": true,
"type": "object",
"properties": {
"type": {
"name": "type",
"title": "Calling Behaviour",
"default": "freeCalling",
"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"
}
],
"readonly": true,
"type": "string",
"description": "This determines how calls are made from this place."
}
},
"title": "Calling"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
},
"NoInstance": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"title": "No Instance"
}
}
}
| 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)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "displayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/WebexWorkspaceCallSettings/?skip=0&limit=3&order_by=displayName&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/WebexWorkspaceCallSettings/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/WebexWorkspaceCallSettings/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/WebexWorkspaceCallSettings/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/WebexWorkspaceCallSettings/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/WebexWorkspaceCallSettings/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/WebexWorkspaceCallSettings",
"model_specific_actions": [
"add",
"export",
"get",
"export_bulkload_template",
"list",
"update",
"remove"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"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/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]. |