[Index]
Model ref.: device/msteamsonline/CsTeamsMeetingPolicy
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": {
"AllowParticipantGiveRequestControl": {
"type": "boolean",
"name": "AllowParticipantGiveRequestControl",
"title": "Allow Participant Give Request Control"
},
"AllowBreakoutRooms": {
"type": "boolean",
"name": "AllowBreakoutRooms",
"title": "Allow Breakout Rooms"
},
"RoomAttributeUserOverride": {
"type": "string",
"name": "RoomAttributeUserOverride",
"title": "Room Attribute User Override"
},
"AllowSharedNotes": {
"type": "boolean",
"name": "AllowSharedNotes",
"title": "Allow Shared Notes"
},
"AllowPrivateMeetNow": {
"type": "boolean",
"name": "AllowPrivateMeetNow",
"title": "Allow Private Meet Now"
},
"StreamingAttendeeMode": {
"type": "string",
"name": "StreamingAttendeeMode",
"title": "Streaming Attendee Mode"
},
"AllowPSTNUsersToBypassLobby": {
"type": "boolean",
"name": "AllowPSTNUsersToBypassLobby",
"title": "Allow PSTN Users To Bypass Lobby"
},
"AllowMeetNow": {
"type": "boolean",
"name": "AllowMeetNow",
"title": "Allow Meet Now"
},
"AllowMeetingReactions": {
"type": "boolean",
"name": "AllowMeetingReactions",
"title": "Allow Meeting Reactions"
},
"AllowCloudRecording": {
"type": "boolean",
"name": "AllowCloudRecording",
"title": "Allow Cloud Recording"
},
"DesignatedPresenterRoleMode": {
"type": "string",
"name": "DesignatedPresenterRoleMode",
"title": "Designated Presenter Role Mode"
},
"AllowEngagementReport": {
"type": "boolean",
"name": "AllowEngagementReport",
"title": "Allow Engagement Report"
},
"EnrollUserOverride": {
"type": "string",
"name": "EnrollUserOverride",
"title": "Enroll User Override"
},
"AllowOrganizersToOverrideLobbySettings": {
"type": "boolean",
"name": "AllowOrganizersToOverrideLobbySettings",
"title": "Allow Organizers To Override Lobby Settings"
},
"PSShowComputerName": {
"type": "boolean",
"name": "PSShowComputerName",
"title": "PS Show Computer Name"
},
"AllowMeetingRegistration": {
"type": "boolean",
"name": "AllowMeetingRegistration",
"title": "Allow Meeting Registration"
},
"AllowAnonymousUsersToStartMeeting": {
"type": "boolean",
"name": "AllowAnonymousUsersToStartMeeting",
"title": "Allow Anonymous Users To Start Meeting"
},
"PreferredMeetingProviderForIslandsMode": {
"type": "string",
"name": "PreferredMeetingProviderForIslandsMode",
"title": "Preferred Meeting Provider For Islands Mode"
},
"AllowChannelMeetingScheduling": {
"type": "boolean",
"name": "AllowChannelMeetingScheduling",
"title": "Allow Channel Meeting Scheduling"
},
"Description": {
"type": "string",
"name": "Description",
"title": "Description"
},
"AllowTrackingInReport": {
"type": "boolean",
"name": "AllowTrackingInReport",
"title": "Allow Tracking In Report"
},
"AllowWhiteboard": {
"type": "boolean",
"name": "AllowWhiteboard",
"title": "Allow Whiteboard"
},
"PSComputerName": {
"type": "string",
"name": "PSComputerName",
"title": "PS Computer Name"
},
"AllowRecordingStorageOutsideRegion": {
"type": "boolean",
"name": "AllowRecordingStorageOutsideRegion",
"title": "Allow Recording Storage Outside Region"
},
"IPAudioMode": {
"type": "string",
"name": "IPAudioMode",
"title": "IP Audio Mode"
},
"AllowOutlookAddIn": {
"type": "boolean",
"name": "AllowOutlookAddIn",
"title": "Allow Outlook Add In"
},
"MeetingChatEnabledType": {
"type": "string",
"name": "MeetingChatEnabledType",
"title": "Meeting Chat Enabled Type"
},
"AllowTranscription": {
"type": "boolean",
"name": "AllowTranscription",
"title": "Allow Transcription"
},
"MediaBitRateKb": {
"type": "string",
"name": "MediaBitRateKb",
"title": "Media Bit Rate Kb"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"AllowPrivateMeetingScheduling": {
"type": "boolean",
"name": "AllowPrivateMeetingScheduling",
"title": "Allow Private Meeting Scheduling"
},
"AllowUserToJoinExternalMeeting": {
"type": "boolean",
"name": "AllowUserToJoinExternalMeeting",
"title": "Allow User To Join External Meeting"
},
"TeamsCameraFarEndPTZMode": {
"type": "string",
"name": "TeamsCameraFarEndPTZMode",
"title": "Teams Camera Far End PTZ Mode"
},
"AllowIPAudio": {
"type": "boolean",
"name": "AllowIPAudio",
"title": "Allow IP Audio"
},
"LiveCaptionsEnabledType": {
"type": "string",
"name": "LiveCaptionsEnabledType",
"title": "Live Captions Enabled Type"
},
"AllowPowerPointSharing": {
"type": "boolean",
"name": "AllowPowerPointSharing",
"title": "Allow Power Point Sharing"
},
"AllowNDIStreaming": {
"type": "boolean",
"name": "AllowNDIStreaming",
"title": "Allow NDI Streaming"
},
"IPVideoMode": {
"type": "string",
"name": "IPVideoMode",
"title": "IP Video Mode"
},
"VideoFiltersMode": {
"type": "string",
"name": "VideoFiltersMode",
"title": "Video Filters Mode"
},
"AutoAdmittedUsers": {
"type": "string",
"name": "AutoAdmittedUsers",
"title": "Auto Admitted Users"
},
"WhoCanRegister": {
"type": "string",
"name": "WhoCanRegister",
"title": "Who Can Register"
},
"RecordingStorageMode": {
"type": "string",
"name": "RecordingStorageMode",
"title": "Recording Storage Mode"
},
"AllowScreenContentDigitization": {
"type": "boolean",
"name": "AllowScreenContentDigitization",
"title": "Allow Screen Content Digitization"
},
"ScreenSharingMode": {
"type": "string",
"name": "ScreenSharingMode",
"title": "Screen Sharing Mode"
},
"AllowAnonymousUsersToDialOut": {
"type": "boolean",
"name": "AllowAnonymousUsersToDialOut",
"title": "Allow Anonymous Users To Dial Out"
},
"AllowExternalParticipantGiveRequestControl": {
"type": "boolean",
"name": "AllowExternalParticipantGiveRequestControl",
"title": "Allow External Participant Give Request Control"
},
"AllowIPVideo": {
"type": "boolean",
"name": "AllowIPVideo",
"title": "Allow IP Video"
},
"SpeakerAttributionMode": {
"type": "string",
"name": "SpeakerAttributionMode",
"title": "Speaker Attribution Mode"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsTeamsMeetingPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsTeamsMeetingPolicy/[pkid1]", "/api/v0/device/msteamsonline/CsTeamsMeetingPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTeamsMeetingPolicy |
|
{"hrefs": ["/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTeamsMeetingPolicy |
|
{"hrefs": ["/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid1]", "/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsTeamsMeetingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsTeamsMeetingPolicy/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid1]", "/api/device/msteamsonline/CsTeamsMeetingPolicy/[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/msteamsonline/CsTeamsMeetingPolicy and the JSON format can be used to import instances of device/msteamsonline/CsTeamsMeetingPolicy.
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsTeamsMeetingPolicy | POST | /api/device/msteamsonline/CsTeamsMeetingPolicy/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/msteamsonline/CsTeamsMeetingPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/ |
|
The device/msteamsonline/CsTeamsMeetingPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsTeamsMeetingPolicy instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2019.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/msteamsonline/CsTeamsMeetingPolicy/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/msteamsonline/CsTeamsMeetingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/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/msteamsonline/CsTeamsMeetingPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/+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/device/msteamsonline/CsTeamsMeetingPolicy/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"model_specific_actions": [
"list",
"get",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"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/msteamsonline/CsTeamsMeetingPolicy. | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsTeamsMeetingPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsTeamsMeetingPolicy | 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/msteamsonline/CsTeamsMeetingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/[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/msteamsonline/CsTeamsMeetingPolicy and the JSON format can be used to import instances of device/msteamsonline/CsTeamsMeetingPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/msteamsonline/CsTeamsMeetingPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsTeamsMeetingPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |