[Index]
Defines configuration options for turning features on/off.
Model ref.: data/SelfServiceFeatureDisplayPolicy
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": { "update_presence_from_calendar": { "title": "Automatically update Presence Status from calendar", "type": "string", "description": "Allow users to manage the setting that automatically updates their presence status based on their calendar. The user must have 'IM and Presence' enabled, and Self Service 'My Availability' settings must be in 'Show' state.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "cli": { "title": "CLI (Calling Line Identification)", "type": "string", "description": "Turn CLI on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "speed_dials": { "title": "Speed Dials", "type": "string", "description": "Turn speed dials on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "phones": { "properties": { "device_type_list": { "items": { "type": "object", "properties": { "config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Configuration Template", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "devicetype": { "type": "string", "title": "Device Name" }, "device_name_prefix": { "type": "string", "title": "Device Name Prefix" } } }, "type": "array", "title": "Device Configuration Templates for User Phone Add" }, "own_phone_add": { "default": "false", "type": "boolean", "title": "User can add own smart devices" }, "own_phone_add_if_entitled": { "default": "false", "type": "boolean", "title": "User can add own smart devices only if the user's Entitlement Profile includes 'Voice'" }, "phone_management": { "title": "Phone Management", "type": "string", "description": "Turn phone management on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "phone_line_management": { "title": "Phone Line Management", "type": "string", "description": "Turn phone line management on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "own_phone_add_limit_entitlement": { "default": "false", "type": "boolean", "title": "Limit the user's total number of phones the number allowed by the user's Entitlement Profile" } }, "type": "object", "description": "Configure Phone features.", "title": "Phones" }, "voicemail": { "properties": { "phone_notification_device": { "title": "Phone Notification Device", "type": "string", "description": "Show / Hide Phone Notification Device management from end user", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "voicemail_basic": { "title": "Voicemail Basic", "type": "string", "description": "Turn basic voicemail on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "voicemail_callerinput": { "title": "Voicemail Caller Input", "type": "string", "description": "Turn voicemail caller input on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "user_add_vm_account_if_entitled": { "default": "false", "type": "boolean", "title": "User can enable Voicemail only if the user is entitled to Voicemail" }, "cucphonedevice_config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Configuration Template for end user add Phone Notification Devices", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "user_add_vm_account": { "default": "false", "type": "boolean", "title": "User can enable Voicemail (Add a Voicemail Account)" }, "voicemail_devices": { "title": "Voicemail Devices", "type": "string", "description": "Turn voicemail devices on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "cucaltext_config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Configuration Template for end user Alternate Extensions for Voicemail", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "alternate_extensions": { "title": "Voicemail Alternate Extensions", "type": "string", "description": "Show / Hide Voicemail Alternate Extension management from end user", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "voicemail_config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Device Configuration Template for End User Voicemail Account Add", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "email_relay": { "title": "Voicemail Email Relay", "type": "string", "description": "Show / Hide Email Relay from end user.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "cucsmsdevice_config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Configuration Template for end user add SMS Notification Devices", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "sms_notification_device": { "title": "SMS Notification Device", "type": "string", "description": "Show / Hide SMS Notification Device management from end user", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] } }, "type": "object", "description": "Configure Voicemail features.", "title": "Voicemail" }, "personal_phones": { "properties": { "rdp_config_template": { "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Device Configuration Template for End User Remote Destination Profile Add", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "type": "string" }, "personal_phone_management": { "title": "Personal Phone Management", "type": "string", "description": "Turn personal phone management on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "advanced_timer_options": { "title": "Advanced Timer Options", "type": "string", "description": "Turn advanced timer options on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "line_association": { "title": "Line Association", "type": "string", "description": "Turn line association on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "mobileid_management": { "title": "Mobile Id Management", "type": "string", "description": "Turn mobile id management on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "ring_schedules": { "title": "Ring Schedules", "type": "string", "description": "Turn ring schedules on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "user_add_rdp": { "default": "false", "type": "boolean", "title": "User can enable Personal Phone Management (add Remote Destination Profile)" }, "user_add_rdp_if_entitled": { "default": "false", "type": "boolean", "title": "User can enable Personal Phone Management / SNR only if entitled to SNR" } }, "type": "object", "description": "Configure Personal Phone features.", "title": "Personal Phones" }, "my_availability": { "title": "My Availability", "type": "string", "description": "Turn my availability on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "enable_minimal_mode": { "default": false, "type": "boolean", "description": "Display Call Forward settings only minimal mode.", "title": "Enable (CFWD Only) Minimal Mode" }, "call_forward": { "properties": { "call_fwd_adv": { "title": "Advanced Call Forward", "type": "string", "description": "Turn advanced call forwarding on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "call_fwd_basic": { "title": "Call Forward Basic", "type": "string", "description": "Turn basic call forwarding on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] } }, "type": "object", "description": "Configure Call Forward features.", "title": "Call Forward" }, "my_information": { "properties": { "pin": { "title": "Pin", "type": "string", "description": "Turn pin on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "user_data": { "title": "User Data", "type": "string", "description": "Turn user data on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "pin_min_length": { "type": "number", "required": false, "minimum": 0, "maximum": 64, "title": "Minimum Pin Length" }, "webex_link": { "title": "Link to Webex self service portal", "type": "string", "description": "Toggle whether end user portal users can see a link to their Webex self service portal. The user must have an associated webex account in order to have the link.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "user_language": { "title": "User Language", "type": "string", "description": "Turn user language on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "password": { "title": "Password", "type": "string", "description": "Turn password on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] } }, "type": "object", "description": "Configure My Information features.", "title": "My Information" }, "fmc": { "title": "FMC (Fixed Mobile Convergence)", "type": "string", "description": "Turn FMC on/off.", "choices": [ { "value": "hidden", "title": "Hide" }, { "value": "show", "title": "Show" } ] }, "name": { "required": true, "type": "string", "description": "The name of the Feature Group.", "title": "Name" } }, "schema_version": "0.1.6" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/SelfServiceFeatureDisplayPolicy/add/ |
|
The GUI Add form of data/SelfServiceFeatureDisplayPolicy 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/data/SelfServiceFeatureDisplayPolicy/ | 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/data/SelfServiceFeatureDisplayPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SelfServiceFeatureDisplayPolicy/[pkid1]", "/api/data/SelfServiceFeatureDisplayPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/SelfServiceFeatureDisplayPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/SelfServiceFeatureDisplayPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/SelfServiceFeatureDisplayPolicy/[pkid1]", "/api/v0/data/SelfServiceFeatureDisplayPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SelfServiceFeatureDisplayPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SelfServiceFeatureDisplayPolicy/export/ |
|
{ "hrefs":["/api/data/SelfServiceFeatureDisplayPolicy/[pkid1]", "/api/data/SelfServiceFeatureDisplayPolicy/[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 data/SelfServiceFeatureDisplayPolicy and the JSON format can be used to import instances of data/SelfServiceFeatureDisplayPolicy.
GET http://[host-proxy]/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/SelfServiceFeatureDisplayPolicy | POST | /api/data/SelfServiceFeatureDisplayPolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/SelfServiceFeatureDisplayPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/SelfServiceFeatureDisplayPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/SelfServiceFeatureDisplayPolicy/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/SelfServiceFeatureDisplayPolicy/ |
|
The data/SelfServiceFeatureDisplayPolicy schema and all instances as JSON. |
(The list will return 0 to 3 data/SelfServiceFeatureDisplayPolicy instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/SelfServiceFeatureDisplayPolicy/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 1 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.6", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/SelfServiceFeatureDisplayPolicy/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/data/SelfServiceFeatureDisplayPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SelfServiceFeatureDisplayPolicy/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/SelfServiceFeatureDisplayPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/SelfServiceFeatureDisplayPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/SelfServiceFeatureDisplayPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/SelfServiceFeatureDisplayPolicy/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SelfServiceFeatureDisplayPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "transform": { "support_async": false, "class": "transform", "href": "/api/data/SelfServiceFeatureDisplayPolicy/transform/?hierarchy=[hierarchy]", "method": "GET", "title": "Transform Template" } } ], "model_type": "data/SelfServiceFeatureDisplayPolicy", "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "transform", "remove", "tag", "tag_version", "update" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "61b0e44141e9336d6e1ed329", "meta": { "tags": [ "V4UC", "ba_EnterpriseOverlay" ], "cached": true, "title": "Default", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.6", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b0e44141e9336d6e1ed329", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [ { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.0.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.1.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.2.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "personal_phones.rdp_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.voicemail_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucaltext_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucphonedevice_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucsmsdevice_config_template" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/help", "method": "GET", "title": "Help" } } ], "model_type": "data/SelfServiceFeatureDisplayPolicy", "path": [ "6t0ggef2c0deab00hb595101", "61b0e44141e9336d6e1ed329" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "update_presence_from_calendar": "show", "name": "Default", "speed_dials": "show", "pkid": "61b0e44141e9336d6e1ed332", "phones": { "device_type_list": [ { "config_template": "Default CUCM Jabber iPhone Template", "devicetype": "iPhone", "device_name_prefix": "TCT" }, { "config_template": "Default CUCM Jabber iPad Template", "devicetype": "iPad", "device_name_prefix": "TAB" }, { "config_template": "Default CUCM Jabber Android Template", "devicetype": "Android Phone or Tablet", "device_name_prefix": "BOT" } ], "own_phone_add": true, "own_phone_add_if_entitled": true, "phone_management": "show", "phone_line_management": "show", "own_phone_add_limit_entitlement": true }, "voicemail": { "phone_notification_device": "show", "voicemail_basic": "show", "voicemail_callerinput": "show", "user_add_vm_account_if_entitled": true, "cucphonedevice_config_template": "Default Self Service Phone Device Notification Template", "user_add_vm_account": true, "voicemail_devices": "show", "cucaltext_config_template": "Default Self Service Alternate Extension Template", "alternate_extensions": "show", "voicemail_config_template": "Default CUC User Template", "cucsmsdevice_config_template": "Default Self Service SMS Device Notification Template", "sms_notification_device": "show" }, "personal_phones": { "rdp_config_template": "Default CUCM RDP Template", "personal_phone_management": "show", "advanced_timer_options": "show", "line_association": "show", "mobileid_management": "show", "ring_schedules": "show", "user_add_rdp": true, "user_add_rdp_if_entitled": true }, "my_availability": "show", "call_forward": { "call_fwd_adv": "show", "call_fwd_basic": "show" }, "my_information": { "pin": "show", "user_data": "show", "pin_min_length": 5, "webex_link": "show", "user_language": "show", "password": "show" }, "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys" } } ] }
(Show the first instance)
{ "pkid": "61b0e44141e9336d6e1ed329", "meta": { "tags": [ "V4UC", "ba_EnterpriseOverlay" ], "cached": false, "title": "Default", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.6", "references": { "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "self": [ { "pkid": "61b0e44141e9336d6e1ed329", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/" } ], "foreign_key": [ { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.0.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.1.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "phones.device_type_list.2.config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "personal_phones.rdp_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.voicemail_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucaltext_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucphonedevice_config_template" }, { "model_type": "data/ConfigurationTemplate", "path": "voicemail.cucsmsdevice_config_template" } ], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SelfServiceFeatureDisplayPolicy/61b0e44141e9336d6e1ed329/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/SelfServiceFeatureDisplayPolicy", "path": [ "6t0ggef2c0deab00hb595101", "61b0e44141e9336d6e1ed329" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "update_presence_from_calendar": "show", "name": "Default", "speed_dials": "show", "pkid": "61b0e44141e9336d6e1ed332", "phones": { "device_type_list": [ { "devicetype": "iPhone", "config_template": "Default CUCM Jabber iPhone Template", "device_name_prefix": "TCT" }, { "devicetype": "iPad", "config_template": "Default CUCM Jabber iPad Template", "device_name_prefix": "TAB" }, { "devicetype": "Android Phone or Tablet", "config_template": "Default CUCM Jabber Android Template", "device_name_prefix": "BOT" } ], "own_phone_add": true, "own_phone_add_if_entitled": true, "phone_management": "show", "phone_line_management": "show", "own_phone_add_limit_entitlement": true }, "voicemail": { "phone_notification_device": "show", "cucphonedevice_config_template": "Default Self Service Phone Device Notification Template", "voicemail_callerinput": "show", "user_add_vm_account_if_entitled": true, "voicemail_basic": "show", "user_add_vm_account": true, "voicemail_devices": "show", "cucaltext_config_template": "Default Self Service Alternate Extension Template", "alternate_extensions": "show", "voicemail_config_template": "Default CUC User Template", "cucsmsdevice_config_template": "Default Self Service SMS Device Notification Template", "sms_notification_device": "show" }, "personal_phones": { "rdp_config_template": "Default CUCM RDP Template", "personal_phone_management": "show", "advanced_timer_options": "show", "line_association": "show", "mobileid_management": "show", "ring_schedules": "show", "user_add_rdp": true, "user_add_rdp_if_entitled": true }, "my_availability": "show", "call_forward": { "call_fwd_adv": "show", "call_fwd_basic": "show" }, "my_information": { "pin": "show", "user_data": "show", "pin_min_length": 5, "webex_link": "show", "user_language": "show", "password": "show" } } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/SelfServiceFeatureDisplayPolicy. | GET | /api/data/SelfServiceFeatureDisplayPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SelfServiceFeatureDisplayPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/SelfServiceFeatureDisplayPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/SelfServiceFeatureDisplayPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/SelfServiceFeatureDisplayPolicy/[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 data/SelfServiceFeatureDisplayPolicy and the JSON format can be used to import instances of data/SelfServiceFeatureDisplayPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/ | hierarchy=[hierarchy] | The data/SelfServiceFeatureDisplayPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/SelfServiceFeatureDisplayPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SelfServiceFeatureDisplayPolicy. |