[Index]
Model ref.: device/skypeforbusiness/CsDialInConferencingDtmfConfiguration
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": { "AdmitAll": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8.", "title": "AdmitAll", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AdmitAll" }, "PrivateRollCallCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed to privately play the name of each conference participant. The default key is 3.", "title": "PrivateRollCallCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "PrivateRollCallCommand" }, "OperatorLineUri": { "__type_requested": "String", "required": false, "description": "Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. Pressing *0 is designed to connect dial-in conferencing users to operator assistance.", "title": "OperatorLineUri", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "OperatorLineUri" }, "ScopeClass": { "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", "required": false, "name": "ScopeClass", "title": "ScopeClass", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "LockUnlockConferenceCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed to lock or unlock a conference. If a conference is locked, then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. The default key is 7.", "title": "LockUnlockConferenceCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "LockUnlockConferenceCommand" }, "CommandCharacter": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*). The only other allowed value is #.", "title": "CommandCharacter", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CommandCharacter" }, "EnableDisableAnnouncementsCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9.", "title": "EnableDisableAnnouncementsCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "EnableDisableAnnouncementsCommand" }, "AudienceMuteCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key a presenter can press to mute or unmute everyone else in the conference (that is, everyone other than the presenter will be muted or unmuted). The default key is 4.", "title": "AudienceMuteCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AudienceMuteCommand" }, "HelpCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1.", "title": "HelpCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "HelpCommand" }, "Anchor": { "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", "required": false, "name": "Anchor", "title": "Anchor", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Identity": { "__type_requested": "string", "required": true, "description": "Unique identifier to be assigned to the new collection of DTMF configuration settings. Because you can only create new collections at the site scope, the Identity will always be the prefix \"site:\" followed by the site name; for example \"site:Redmond\".", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "MuteUnmuteCommand": { "__type_requested": "String", "required": false, "description": "Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. The default key is 6.", "title": "MuteUnmuteCommand", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MuteUnmuteCommand" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/add/ |
|
The GUI Add form of device/skypeforbusiness/CsDialInConferencingDtmfConfiguration 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/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/ | 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/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid1]", "/api/v0/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsDialInConferencingDtmfConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsDialInConferencingDtmfConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsDialInConferencingDtmfConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[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 device/skypeforbusiness/CsDialInConferencingDtmfConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsDialInConferencingDtmfConfiguration.
GET http://[host-proxy]/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsDialInConferencingDtmfConfiguration | POST | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/ |
|
The device/skypeforbusiness/CsDialInConferencingDtmfConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsDialInConferencingDtmfConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1150", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/skypeforbusiness/CsDialInConferencingDtmfConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsDialInConferencingDtmfConfiguration", "model_specific_actions": [ "get", "list", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsDialInConferencingDtmfConfiguration. | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsDialInConferencingDtmfConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsDialInConferencingDtmfConfiguration | 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 device/skypeforbusiness/CsDialInConferencingDtmfConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[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 device/skypeforbusiness/CsDialInConferencingDtmfConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsDialInConferencingDtmfConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsDialInConferencingDtmfConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsDialInConferencingDtmfConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsDialInConferencingDtmfConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |