[Index]
Model ref.: device/skypeforbusinessonline/CsMeetingConfiguration
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": { "AdmitAnonymousUsersByDefault": { "__type_requested": "System.Boolean", "required": true, "name": "AdmitAnonymousUsersByDefault", "title": "AdmitAnonymousUsersByDefault", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Determines whether meetings will, by default, allow attendance by anonymous users (that is, by unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True." }, "UserUriFormatForStUser": { "__type_requested": "String", "required": true, "name": "UserUriFormatForStUser", "title": "UserUriFormatForStUser", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "PARAMVALUE: String" }, "ScopeClass": { "__type_requested": "System.String", "required": true, "name": "ScopeClass", "title": "ScopeClass", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AllowCloudRecordingService": { "__type_requested": "System.Boolean", "required": true, "name": "AllowCloudRecordingService", "title": "AllowCloudRecordingService", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "PARAMVALUE: $true | $false" }, "PstnCallersBypassLobby": { "__type_requested": "System.Boolean", "required": true, "name": "PstnCallersBypassLobby", "title": "PstnCallersBypassLobby", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. If set to True ($True), PSTN callers will automatically be admitted to the meeting. If set to False ($False), then PSTN callers will initially be routed to the conference lobby. At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. The default value is True." }, "LogoURL": { "__type_requested": "String", "required": true, "name": "LogoURL", "title": "LogoURL", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "URL for the image to be used on custom meeting invitations." }, "HelpURL": { "__type_requested": "String", "required": true, "name": "HelpURL", "title": "HelpURL", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "URL to a website where users can obtain assistance on joining the meeting." }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "EnableMeetingReport": { "__type_requested": "System.Boolean", "required": true, "name": "EnableMeetingReport", "title": "EnableMeetingReport", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "PARAMVALUE: $true | $false" }, "DesignateAsPresenter": { "__type_requested": "System.String", "required": true, "name": "DesignateAsPresenter", "title": "DesignateAsPresenter", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company; and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization will have presenter rights the moment they join a meeting." }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "LegalURL": { "__type_requested": "String", "required": true, "name": "LegalURL", "title": "LegalURL", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "URL to a website containing legal information and meeting disclaimers." }, "Anchor": { "__type_requested": "System.String", "required": true, "name": "Anchor", "title": "Anchor", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AllowConferenceRecording": { "__type_requested": "System.Boolean", "required": true, "name": "AllowConferenceRecording", "title": "AllowConferenceRecording", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Determines whether or not users are allowed to record conference proceedings. The default value is True." }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "Specifies the collection of meeting configuration settings to be returned. Because each tenant is limited to a single, global collection of meeting configuration settings there is no need include this parameter when calling the Get-CsMeetingConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. For example:\nGet-CsMeetingConfiguration -Tenant \"bf19b7db-6960-41e5-a139-2aa373474354\" -Identity \"global\"" }, "RequireRoomSystemsAuthorization": { "__type_requested": "System.Boolean", "required": true, "name": "RequireRoomSystemsAuthorization", "title": "RequireRoomSystemsAuthorization", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. The default value is False ($False)." }, "AssignedConferenceTypeByDefault": { "__type_requested": "System.Boolean", "required": true, "name": "AssignedConferenceTypeByDefault", "title": "AssignedConferenceTypeByDefault", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Determines whether new meetings will be configured, by default, as public meetings. Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True." }, "Element": { "__type_requested": "System.String", "required": true, "name": "Element", "title": "Element", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "XsAnyElements": { "__type_requested": "System.String", "required": false, "name": "XsAnyElements", "title": "XsAnyElements", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "XsAnyAttributes": { "__type_requested": "System.String", "required": false, "name": "XsAnyAttributes", "title": "XsAnyAttributes", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CustomFooterText": { "__type_requested": "System.String", "required": true, "name": "CustomFooterText", "title": "CustomFooterText", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "Text to be used on custom meeting invitations." }, "EnableAssignedConferenceType": { "__type_requested": "System.Boolean", "required": true, "name": "EnableAssignedConferenceType", "title": "EnableAssignedConferenceType", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Indicates whether users are allowed to schedule public meetings. With a public meeting, the conference ID and the meeting link remain consistent each time the meeting is held. With a private meeting, the conference ID and meeting link change from meeting to meeting. The default value is True." }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "TypedIdentity": { "__type_requested": "System.String", "required": true, "name": "TypedIdentity", "title": "TypedIdentity", "__type_mapping_type": "String", "readonly": false, "type": "string" } }, "schema_version": "2017.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinessonline/CsMeetingConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid1]", "/api/v0/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinessonline/CsMeetingConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinessonline/CsMeetingConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinessonline/CsMeetingConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid1]", "/api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinessonline/CsMeetingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinessonline/CsMeetingConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid1]", "/api/device/skypeforbusinessonline/CsMeetingConfiguration/[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/skypeforbusinessonline/CsMeetingConfiguration and the JSON format can be used to import instances of device/skypeforbusinessonline/CsMeetingConfiguration.
GET http://[host-proxy]/api/device/skypeforbusinessonline/CsMeetingConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinessonline/CsMeetingConfiguration | POST | /api/device/skypeforbusinessonline/CsMeetingConfiguration/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/skypeforbusinessonline/CsMeetingConfiguration/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/ |
|
The device/skypeforbusinessonline/CsMeetingConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinessonline/CsMeetingConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/?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": "2017.1", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/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/skypeforbusinessonline/CsMeetingConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/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/skypeforbusinessonline/CsMeetingConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinessonline/CsMeetingConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinessonline/CsMeetingConfiguration", "model_specific_actions": [ "get", "list", "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": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusinessonline/CsMeetingConfiguration. | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinessonline/CsMeetingConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinessonline/CsMeetingConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinessonline/CsMeetingConfiguration | 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/skypeforbusinessonline/CsMeetingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[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/skypeforbusinessonline/CsMeetingConfiguration and the JSON format can be used to import instances of device/skypeforbusinessonline/CsMeetingConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinessonline/CsMeetingConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinessonline/CsMeetingConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinessonline/CsMeetingConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |