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