[Index]
WebexLocationCallingSettings
Model ref.: relation/WebexLocationCallingDetails
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": {
"voicePortal": {
"properties": {
"languageCode": {
"type": "string",
"description": "Language code for voicemail group audio announcement.",
"title": "Language Code"
},
"language": {
"type": "string",
"description": "Language for audio announcements.",
"title": "Language"
},
"extension": {
"type": "string",
"description": "Extension of incoming call.",
"title": "Extension"
},
"lastName": {
"type": "string",
"description": "Caller ID Last Name.",
"title": "Last Name"
},
"phoneNumber": {
"type": "string",
"description": "Phone Number of incoming call.",
"title": "Phone Number"
},
"firstName": {
"type": "string",
"description": "Caller ID First Name.",
"title": "First Name"
},
"id": {
"readonly": true,
"type": "string",
"description": "Voice Portal ID",
"title": "ID"
},
"name": {
"type": "string",
"description": "Voice Portal Name.",
"title": "Name"
}
},
"required": false,
"type": "object",
"description": "Location's Voice Portal settings.",
"title": "Voice Portal"
},
"outsideDialDigit": {
"type": "string",
"description": "Must dial to reach an outside line, default is None.",
"title": "Outside Dial Digit"
},
"routingPrefix": {
"type": "string",
"description": "Must dial a prefix when calling between locations having same extension within same location.",
"title": "Routing Prefix"
},
"name": {
"type": "string",
"description": "The name of the location.",
"title": "Name"
},
"pAccessNetworkInfo": {
"type": "string",
"description": "Emergency Location Identifier for a location. Set this field to provide the SIP access network information to the provider which will be used to populate the SIP P-Access-Network-Info header. This is helpful to establish the location of a device when you make an emergency call.",
"title": "PSTN Access Network Info"
},
"callingLineId": {
"properties": {
"phoneNumber": {
"type": "string",
"description": "Directory Number / Main number in E.164 Format.",
"title": "Main Number"
},
"name": {
"type": "string",
"description": "Group calling line ID name. By default the Org nam",
"title": "Name"
}
},
"required": false,
"type": "object",
"description": "Location calling line information.",
"title": "Calling Line ID"
},
"externalCallerIdName": {
"type": "string",
"description": "External Caller ID Name value. Unicode characters.",
"title": "External Caller ID Name"
},
"intercept": {
"properties": {
"incoming": {
"properties": {
"announcements": {
"properties": {
"newNumber": {
"properties": {
"destination": {
"type": "string",
"description": "Incoming destination phone number to be announced.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable to play new number announcement.",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Settings for new number announcement.",
"title": "New Number"
},
"zeroTransfer": {
"properties": {
"destination": {
"type": "string",
"description": "Transfer phone number to be called when '0' is dialed.",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable to transfer to phone number.",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Transfer number details.",
"title": "Zero Transfer"
},
"greeting": {
"choices": [
{
"value": "DEFAULT",
"title": "DEFAULT"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"type": "string",
"description": "Greeting type for location intercept.",
"title": "Greeting"
},
"fileName": {
"type": "string",
"description": "If set to CUSTOM for greeting, filename of previously uploaded file.",
"title": "File Name"
}
},
"required": false,
"type": "object",
"description": "Announcements details.",
"title": "Announcements"
},
"type": {
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_ALL",
"title": "ALLOW_ALL"
}
],
"type": "string",
"description": "Select inbound call options.",
"title": "Type"
},
"voicemailEnabled": {
"type": "boolean",
"description": "Enable/disable to route voice mail.",
"title": "Voicemail Enabled"
}
},
"required": false,
"type": "object",
"description": "Inbound call details.",
"title": "Incoming"
},
"outgoing": {
"properties": {
"destination": {
"type": "string",
"description": "If enabled, set outgoing destination phone number.",
"title": "Destination"
},
"type": {
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "INTERCEPT_ALL"
},
{
"value": "ALLOW_LOCAL_ONLY",
"title": "ALLOW_LOCAL_ONLY"
}
],
"type": "string",
"description": "Outbound call modes",
"title": "Type"
},
"transferEnabled": {
"type": "boolean",
"description": "Enable/disable to route all outbound calls to phone number.",
"title": "Transfer Enabled"
}
},
"required": false,
"type": "object",
"description": "Outbound Call details",
"title": "Outgoing"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable location intercept. Enable this feature to override any Location's Call Intercept settings that person configures.",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Location's intercept settings.",
"title": "Intercept"
},
"callingPermissions": {
"properties": {
"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": "Location's 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": "Location Outgoing Calling Permissions"
},
"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": "No Instance"
},
"connection": {
"properties": {
"type": {
"choices": [
{
"value": "ROUTE_GROUP",
"title": "ROUTE_GROUP"
},
{
"value": "TRUNK",
"title": "TRUNK"
}
],
"type": "string",
"description": "Webex Calling location only suppports TRUNK and ROUTE_GROUP connection type.",
"title": "Type"
},
"id": {
"type": "string",
"description": "A unique identifier of route type.",
"title": "ID"
}
},
"required": false,
"type": "object",
"description": "Connection details are only returned for local PSTN types of TRUNK or ROUTE_GROUP.",
"title": "Connection"
},
"userLimit": {
"readonly": true,
"type": "integer",
"description": "Limit on the number of people at the location, Read-Only.",
"title": "User Limit"
},
"musicOnHold": {
"properties": {
"audioFile": {
"properties": {
"level": {
"choices": [
{
"value": "ORGANIZATION",
"title": "ORGANIZATION"
},
{
"value": "LOCATION",
"title": "LOCATION"
}
],
"type": "string",
"description": "Audio announcement file type location.",
"title": "Level"
},
"mediaFileType": {
"choices": [
{
"value": "WAV",
"title": "WAV"
},
{
"value": "WMA",
"title": "WMA"
},
{
"value": "3GP",
"title": "3GP"
}
],
"type": "string",
"description": "Audio announcement file type",
"title": "Media File Type"
},
"id": {
"type": "string",
"description": "A unique identifier for the announcement.",
"title": "ID"
},
"fileName": {
"type": "string",
"description": "Audio announcement file name.",
"title": "File Name"
}
},
"required": false,
"type": "object",
"description": "Announcement Audio File details when greeting is selected to be CUSTOM.",
"title": "Audio File"
},
"callParkEnabled": {
"type": "boolean",
"description": "If enabled, music will be played when call is parked.",
"title": "Call Park Enabled"
},
"callHoldEnabled": {
"type": "boolean",
"description": "If enabled, music will be played when call is placed on hold.",
"title": "Call Hold Enabled"
},
"greeting": {
"choices": [
{
"value": "SYSTEM",
"title": "SYSTEM"
},
{
"value": "CUSTOM",
"title": "CUSTOM"
}
],
"type": "string",
"description": "Greeting type for the location.",
"title": "Greeting"
}
},
"required": false,
"type": "object",
"description": "Location's music on hold settings.",
"title": "Music On Hold"
},
"announcementLanguage": {
"type": "string",
"description": "Location's phone announcement language.",
"title": "Announcement Language"
},
"emergencyCallbackNumber": {
"properties": {
"locationInfo": {
"properties": {
"effectiveValue": {
"readonly": true,
"type": "string",
"description": "Location calling line ID (CLID) number. Avaliable only when number is present and quality would be invalid.",
"title": "Effective Value"
},
"effectiveLevel": {
"readonly": true,
"choices": [
{
"value": "LOCATION_NUMBER",
"title": "LOCATION_NUMBER"
},
{
"value": "LOCATION_MEMBER_NUMBER",
"title": "LOCATION_MEMBER_NUMBER"
},
{
"value": "'NONE'",
"title": "'NONE'"
}
],
"type": "string",
"description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.",
"title": "Effective Level"
},
"phoneNumber": {
"readonly": true,
"type": "string",
"description": "The location DN.",
"title": "Phone Number"
},
"name": {
"readonly": true,
"type": "string",
"description": "The name of the location.",
"title": "Name"
},
"quality": {
"readonly": true,
"choices": [
{
"value": "RECOMMENDED",
"title": "RECOMMENDED"
},
{
"value": "NOT_RECOMMENDED",
"title": "NOT_RECOMMENDED"
},
{
"value": "INVALID",
"title": "INVALID"
}
],
"type": "string",
"description": "Used to represent whether a number is a recommended ECBN.",
"title": "Quality"
}
},
"required": false,
"type": "object",
"description": "Data relevant to this location.",
"title": "Location Info"
},
"locationMemberInfo": {
"properties": {
"firstName": {
"readonly": true,
"type": "string",
"description": "The member first name.",
"title": "First Name"
},
"effectiveValue": {
"readonly": true,
"type": "string",
"description": "Location CLID number. Avaliable only when number is present and quality would be invalid.",
"title": "Effective Value"
},
"lastName": {
"readonly": true,
"type": "string",
"description": "The member last name. Always contains . if the member is a place",
"title": "Last Name"
},
"memberType": {
"readonly": true,
"choices": [
{
"value": "PEOPLE",
"title": "PEOPLE"
},
{
"value": "PLACE",
"title": "PLACE"
}
],
"type": "string",
"description": "Member Type.",
"title": "Member Type"
},
"memberId": {
"type": "string",
"description": "Member ID of user/place within the location.",
"title": "Member ID"
},
"phoneNumber": {
"readonly": true,
"type": "string",
"description": "The member DN.",
"title": "Phone Number"
},
"effectiveLevel": {
"choices": [
{
"value": "LOCATION_NUMBER",
"title": "LOCATION_NUMBER"
},
{
"value": "LOCATION_MEMBER_NUMBER",
"title": "LOCATION_MEMBER_NUMBER"
},
{
"value": "'NONE'",
"title": "'NONE'"
}
],
"type": "string",
"description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.",
"title": "Effective Level"
},
"quality": {
"readonly": true,
"choices": [
{
"value": "RECOMMENDED",
"title": "RECOMMENDED"
},
{
"value": "NOT_RECOMMENDED",
"title": "NOT_RECOMMENDED"
},
{
"value": "INVALID",
"title": "INVALID"
}
],
"type": "string",
"description": "Used to represent whether a number is a recommended ECBN.",
"title": "Quality"
}
},
"required": false,
"type": "object",
"description": "Data relevant to the user/place (member) selected for ECBN.",
"title": "Location Member Info"
}
},
"required": false,
"type": "object",
"description": "Location's Emergency Callback Number settings.",
"title": "Emergency Callback Number"
},
"chargeNumber": {
"type": "string",
"description": "Chargeable number for the line placing the call. When this is set, all calls placed from this location will include a P-Charge-Info header with the selected number in the SIP INVITE.",
"title": "Charge Number"
},
"internalDialing": {
"properties": {
"unknownExtensionRouteIdentity": {
"properties": {
"type": {
"choices": [
{
"value": "ROUTE_GROUP",
"title": "ROUTE_GROUP"
},
{
"value": "TRUNK",
"title": "TRUNK"
}
],
"type": "string",
"description": "Type associated with the identity.",
"title": "Type"
},
"id": {
"type": "string",
"description": "ID of the route type.",
"title": "ID"
},
"name": {
"type": "string",
"description": "A unique name for the route identity.",
"title": "Name"
}
},
"required": false,
"type": "object",
"description": "The selected route group/trunk as premises calls.",
"title": "Unknown Extension Route Identity"
},
"enableUnknownExtensionRoutePolicy": {
"type": "boolean",
"description": "When enabled, calls made by users at the location to an unknown extension (between 2-6 digits) are routed to the selected route group/trunk as premises calls.",
"title": "Enable Unknown Extension Route Policy"
}
},
"required": false,
"type": "object",
"description": "Internal Dialing settings for a location",
"title": "Internal Dialing"
},
"id": {
"readonly": true,
"type": "string",
"description": "A unique identifier for the location.",
"title": "ID"
},
"defaultDomain": {
"type": "string",
"description": "IP Address, hostname, or domain. Read-Only.",
"title": "Default Domain"
},
"voicemailTranscriptionEnabled": {
"properties": {
"voicemailTranscriptionEnabled": {
"type": "boolean",
"description": "Voicemail Transcription Enabled",
"title": "Voicemail Transcription Enabled"
}
},
"required": false,
"type": "object",
"description": "Voicemail Transcription settings.",
"title": "Voicemail Transcription Enabled"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexLocationCallingDetails/add/ |
|
The GUI Add form of relation/WebexLocationCallingDetails 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/WebexLocationCallingDetails | 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/WebexLocationCallingDetails/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexLocationCallingDetails/[pkid1]", "/api/relation/WebexLocationCallingDetails/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexLocationCallingDetails/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/WebexLocationCallingDetails |
|
{"hrefs": ["/api/relation/WebexLocationCallingDetails/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/WebexLocationCallingDetails |
|
{"hrefs": ["/api/relation/WebexLocationCallingDetails/[pkid1]", "/api/relation/WebexLocationCallingDetails/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexLocationCallingDetails; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexLocationCallingDetails/export/ |
|
{ "hrefs":["/api/relation/WebexLocationCallingDetails/[pkid1]", "/api/relation/WebexLocationCallingDetails/[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/WebexLocationCallingDetails and the JSON format can be used to import instances of relation/WebexLocationCallingDetails.
GET http://[host-proxy]/api/relation/WebexLocationCallingDetails/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/WebexLocationCallingDetails/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebexLocationCallingDetails/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexLocationCallingDetails/ |
|
The relation/WebexLocationCallingDetails schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexLocationCallingDetails instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/WebexLocationCallingDetails/?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/WebexLocationCallingDetails/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/WebexLocationCallingDetails/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/WebexLocationCallingDetails/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/WebexLocationCallingDetails",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/WebexLocationCallingDetails/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/WebexLocationCallingDetails/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/WebexLocationCallingDetails/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/WebexLocationCallingDetails/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/WebexLocationCallingDetails",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "outsideDialDigit",
"title": "Outside Dial Digit"
},
{
"name": "routingPrefix",
"title": "Routing Prefix"
},
{
"name": "announcementLanguage",
"title": "Announcement Language"
},
{
"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/WebexLocationCallingDetails/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebexLocationCallingDetails/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/WebexLocationCallingDetails | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebexLocationCallingDetails; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexLocationCallingDetails/[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/WebexLocationCallingDetails and the JSON format can be used to import instances of relation/WebexLocationCallingDetails.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexLocationCallingDetails/[pkid] | hierarchy=[hierarchy] | The relation/WebexLocationCallingDetails instance with [pkid]. |