[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": {
"description": "Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting.",
"type": "boolean",
"name": "AllowParticipantGiveRequestControl",
"title": "Participants can give or request control"
},
"AllowBreakoutRooms": {
"description": "Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality.",
"type": "boolean",
"name": "AllowBreakoutRooms",
"title": "Allow Breakout Rooms"
},
"AllowSharedNotes": {
"description": "Determines whether users are allowed to take shared Meeting notes. Set this to TRUE to allow. Set this to FALSE to prohibit.",
"type": "boolean",
"name": "AllowSharedNotes",
"title": "Shared Notes"
},
"AllowPrivateMeetNow": {
"description": "This setting controls whether a user can start an ad hoc private meeting.",
"type": "boolean",
"name": "AllowPrivateMeetNow",
"title": "Meet now in private meetings"
},
"StreamingAttendeeMode": {
"description": "Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality).",
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
}
],
"type": "string",
"name": "StreamingAttendeeMode",
"title": "Streaming Attendee Mode"
},
"AllowPSTNUsersToBypassLobby": {
"description": "Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to True, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting.",
"type": "boolean",
"name": "AllowPSTNUsersToBypassLobby",
"title": "People dialing in can bypass the lobby"
},
"AllowMeetNow": {
"description": "Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings.",
"type": "boolean",
"name": "AllowMeetNow",
"title": "Meet now in channel settings"
},
"AllowMeetingReactions": {
"description": "Set to false to disable Meeting Reactions.",
"type": "boolean",
"name": "AllowMeetingReactions",
"title": "Reactions"
},
"AllowCloudRecording": {
"description": "Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings.",
"type": "boolean",
"name": "AllowCloudRecording",
"title": "Meeting Recording"
},
"DesignatedPresenterRoleMode": {
"description": "Determines if users can change the default value of the Who can present? setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings.",
"choices": [
{
"description": "All meeting participants can be presenters. This is the default value. This parameter corresponds to the Everyone setting in Teams.",
"value": "EveryoneUserOverride",
"title": "Everyone"
},
{
"description": "Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the People in my organization setting in Teams.",
"value": "EveryoneInCompanyUserOverride",
"title": "People in my organization"
},
{
"description": "Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the Only me setting in Teams.",
"value": "OrganizerOnlyUserOverride",
"title": "Only organizers and co-organizers"
}
],
"type": "string",
"name": "DesignatedPresenterRoleMode",
"title": "Who can present"
},
"AllowEngagementReport": {
"description": "If set to enabled, only meeting organizers will get a link to download the report in Teams. Regular attendees will have no access to it.",
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "AllowEngagementReport",
"title": "Attendance report"
},
"EnrollUserOverride": {
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
}
],
"type": "string",
"name": "EnrollUserOverride",
"title": "Enroll User Override"
},
"WhoCanRegister": {
"choices": [
{
"value": "Everyone",
"title": "Everyone"
},
{
"value": "EveryoneInCompany",
"title": "EveryoneInCompany"
}
],
"type": "string",
"name": "WhoCanRegister",
"title": "Who Can Register"
},
"AllowMeetingRegistration": {
"description": "Controls if a user can create a webinar meeting. The default value is True.",
"type": "boolean",
"name": "AllowMeetingRegistration",
"title": "Meeting Registration"
},
"AllowAnonymousUsersToStartMeeting": {
"description": "Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting.",
"type": "boolean",
"name": "AllowAnonymousUsersToStartMeeting",
"title": "Anonymous users and dial-in callers can start a meeting"
},
"PreferredMeetingProviderForIslandsMode": {
"description": "Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in.",
"choices": [
{
"value": "TeamsAndSfb",
"title": "TeamsAndSfb"
},
{
"value": "Teams",
"title": "Teams"
}
],
"type": "string",
"name": "PreferredMeetingProviderForIslandsMode",
"title": "Preferred Meeting Provider For Islands Mode"
},
"AllowChannelMeetingScheduling": {
"description": "Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings.",
"type": "boolean",
"name": "AllowChannelMeetingScheduling",
"title": "Channel meeting scheduling"
},
"Description": {
"description": "Enables administrators to provide explanatory text about the meeting policy.",
"type": "string",
"name": "Description",
"title": "Description"
},
"AllowTrackingInReport": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "EnabledUserOverride",
"title": "Enabled User Override"
},
{
"value": "DisabledUserOverride",
"title": "Disabled User Override"
}
],
"type": "string",
"name": "AllowTrackingInReport",
"title": "Include attendees in the report"
},
"AllowWhiteboard": {
"description": "Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit.",
"type": "boolean",
"name": "AllowWhiteboard",
"title": "Whiteboard"
},
"InfoShownInReportMode": {
"choices": [
{
"value": "IdentityOnly",
"title": "Only show who attended"
},
{
"value": "FullInformation",
"title": "Show everything"
}
],
"type": "string",
"name": "InfoShownInReportMode",
"title": "Attendee information"
},
"RoomAttributeUserOverride": {
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "Distinguish",
"title": "Distinguish"
},
{
"value": "Attribute",
"title": "Attribute"
}
],
"type": "string",
"name": "RoomAttributeUserOverride",
"title": "Room Attribute User Override"
},
"ChannelRecordingDownload": {
"description": "Controls how channel meeting recordings are saved, permissioned, and who can download them.",
"choices": [
{
"description": "Saves channel meeting recordings to a \"Recordings\" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel.",
"value": "Allow",
"title": "Allow"
},
{
"description": "Saves channel meeting recordings to a \"Recordings\\View only\" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download.",
"value": "Block",
"title": "Block"
}
],
"type": "string",
"name": "ChannelRecordingDownload",
"title": "Channel Recording Download"
},
"AllowRecordingStorageOutsideRegion": {
"description": "Allows storing recordings outside of the region. All meeting recordings will be permanently stored in another region, and can't be migrated. This does not apply to recordings saved in OneDrive or SharePoint.",
"type": "boolean",
"name": "AllowRecordingStorageOutsideRegion",
"title": "Store recordings outside of your country or region"
},
"IPAudioMode": {
"description": "Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting.",
"choices": [
{
"value": "EnabledOutgoingIncoming",
"title": "Outgoing and incoming audio enabled"
},
{
"value": "Disabled",
"title": "Not enabled"
}
],
"type": "string",
"name": "IPAudioMode",
"title": "Mode for IP audio"
},
"AllowOutlookAddIn": {
"description": "Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client.",
"type": "boolean",
"name": "AllowOutlookAddIn",
"title": "Outlook Add-In"
},
"MeetingChatEnabledType": {
"description": "Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous.",
"choices": [
{
"value": "Disabled",
"title": "Off"
},
{
"value": "Enabled",
"title": "On for everyone"
},
{
"value": "EnabledExceptAnonymous",
"title": "On for everyone but anonymous users"
}
],
"type": "string",
"name": "MeetingChatEnabledType",
"title": "Meeting Chat"
},
"AllowTranscription": {
"description": "Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit.",
"type": "boolean",
"name": "AllowTranscription",
"title": "Transcription"
},
"AllowWatermarkForScreenSharing": {
"description": "This setting allows scheduling meetings with watermarking for screen sharing enabled.",
"type": "boolean",
"name": "AllowWatermarkForScreenSharing",
"title": "Allow Watermark For Screen Sharing"
},
"MediaBitRateKb": {
"description": "Determines the media bit rate for audio/video/app sharing transmissions in meetings.",
"type": "integer",
"name": "MediaBitRateKb",
"title": "Media bit rate (Kbs)"
},
"AllowAnonymousUsersToJoinMeeting": {
"description": "Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting.",
"type": "boolean",
"name": "AllowAnonymousUsersToJoinMeeting",
"title": "Anonymous users can join a meeting"
},
"RecordingsAutomaticExpire": {
"type": "boolean",
"name": "RecordingsAutomaticExpire",
"title": "Recordings Automatically Expire"
},
"AllowNetworkConfigurationSettingsLookup": {
"type": "boolean",
"name": "AllowNetworkConfigurationSettingsLookup",
"title": "Network configuration lookup"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"AllowCartCaptionsScheduling": {
"description": "Controls how channel meeting recordings are saved, permissioned, and who can download them.",
"choices": [
{
"description": "CART captions is available by default but a user can disable.",
"value": "EnabledUserOverride",
"title": "EnabledUserOverride"
},
{
"description": "If you would like users to be able to use CART captions in meetings but by default it is disabled.",
"value": "DisabledUserOverride",
"title": "DisabledUserOverride"
},
{
"description": "If you'd like to not allow CART captions in meeting.",
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "AllowCartCaptionsScheduling",
"title": "Allow Cart Captions Scheduling"
},
"AllowPrivateMeetingScheduling": {
"description": "Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings.",
"type": "boolean",
"name": "AllowPrivateMeetingScheduling",
"title": "Private Meeting Scheduling"
},
"AllowedStreamingMediaInput": {
"description": "Enables the use of RTMP-In in Teams meetings.",
"choices": [
{
"value": "",
"title": ""
},
{
"value": "RTMP",
"title": "RTMP"
}
],
"type": "string",
"name": "AllowedStreamingMediaInput",
"title": "Allowed Streaming Media Input"
},
"TeamsCameraFarEndPTZMode": {
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "AutoAcceptInTenant",
"title": "AutoAcceptInTenant"
},
{
"value": "AutoAcceptAll",
"title": "AutoAcceptAll"
}
],
"type": "string",
"name": "TeamsCameraFarEndPTZMode",
"title": "Teams Camera Far End PTZ Mode"
},
"AllowIPAudio": {
"type": "boolean",
"name": "AllowIPAudio",
"title": "Allow IP Audio"
},
"LiveCaptionsEnabledType": {
"description": "Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit.",
"choices": [
{
"value": "DisabledUserOverride",
"title": "Off, but organizers and co-organizers can turn them on"
},
{
"value": "Disabled",
"title": "Off"
}
],
"type": "string",
"name": "LiveCaptionsEnabledType",
"title": "Live Captions"
},
"AllowPowerPointSharing": {
"description": "Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit.",
"type": "boolean",
"name": "AllowPowerPointSharing",
"title": "PowerPoint Live"
},
"AllowNDIStreaming": {
"description": "This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network.",
"type": "boolean",
"name": "AllowNDIStreaming",
"title": "Broadcast production with NDI and SDI hardware"
},
"IPVideoMode": {
"choices": [
{
"value": "EnabledOutgoingIncoming",
"title": "Outgoing and incoming video enabled"
},
{
"value": "Disabled",
"title": "Not enabled"
}
],
"type": "string",
"name": "IPVideoMode",
"title": "Mode for IP video"
},
"VideoFiltersMode": {
"choices": [
{
"description": "No filters are available.",
"value": "NoFilters",
"title": "Off"
},
{
"description": "Background blur is the only option available (requires a processor with AVX2 support, see Hardware requirements for Microsoft Teams for more information).",
"value": "BlurOnly",
"title": "Only Background Blur"
},
{
"description": "Background blur and a list of pre-selected images are available.",
"value": "BlurAndDefaultBackgrounds",
"title": "Only background blur and default backgrounds"
},
{
"description": "All filters are available, including custom images.",
"value": "AllFilters",
"title": "All video effects"
}
],
"type": "string",
"name": "VideoFiltersMode",
"title": "Participants can use video effects"
},
"NewMeetingRecordingExpirationDays": {
"description": "Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. Value can also be -1 to set meeting recordings to never expire.",
"type": "integer",
"name": "NewMeetingRecordingExpirationDays",
"title": "Default expiration time"
},
"LiveStreamingMode": {
"description": "Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP).",
"choices": [
{
"value": "Enabled",
"title": "On"
},
{
"value": "Disabled",
"title": "Off"
}
],
"type": "string",
"name": "LiveStreamingMode",
"title": "Live Streaming"
},
"AutoAdmittedUsers": {
"choices": [
{
"description": "If you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately.",
"value": "EveryoneInCompany",
"title": "People in my org"
},
{
"description": "If you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby.",
"value": "EveryoneInSameAndFederatedCompany",
"title": "People in my org, trusted orgs, and guests"
},
{
"description": "If you'd like to admit anonymous users by default.",
"value": "Everyone",
"title": "Everyone"
},
{
"description": "If you would like that only meeting organizers can bypass the lobby.",
"value": "OrganizerOnly",
"title": "Only organizers and co-organizers"
},
{
"description": "If you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately.",
"value": "EveryoneInCompanyExcludingGuests",
"title": "People in my org and guests"
},
{
"description": "If you would like that only meeting organizers and invited users can bypass the lobby.",
"value": "InvitedUsers",
"title": "People who were invited"
}
],
"type": "string",
"name": "AutoAdmittedUsers",
"title": "Who can bypass the lobby"
},
"MeetingInviteLanguages": {
"description": "Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed.",
"choices": [
{
"value": "ar-SA",
"title": "ar-SA"
},
{
"value": "az-Latn-AZ",
"title": "az-Latn-AZ"
},
{
"value": "bg-BG",
"title": "bg-BG"
},
{
"value": "ca-ES",
"title": "ca-ES"
},
{
"value": "cs-CZ",
"title": "cs-CZ"
},
{
"value": "cy-GB",
"title": "cy-GB"
},
{
"value": "da-DK",
"title": "da-DK"
},
{
"value": "de-DE",
"title": "de-DE"
},
{
"value": "el-GR",
"title": "el-GR"
},
{
"value": "en-GB",
"title": "en-GB"
},
{
"value": "en-US",
"title": "en-US"
},
{
"value": "es-ES",
"title": "es-ES"
},
{
"value": "es-MX",
"title": "es-MX"
},
{
"value": "et-EE",
"title": "et-EE"
},
{
"value": "eu-ES",
"title": "eu-ES"
},
{
"value": "fi-FI",
"title": "fi-FI"
},
{
"value": "fil-PH",
"title": "fil-PH"
},
{
"value": "fr-CA",
"title": "fr-CA"
},
{
"value": "fr-FR",
"title": "fr-FR"
},
{
"value": "gl-ES",
"title": "gl-ES"
},
{
"value": "he-IL",
"title": "he-IL"
},
{
"value": "hi-IN",
"title": "hi-IN"
},
{
"value": "hr-HR",
"title": "hr-HR"
},
{
"value": "hu-HU",
"title": "hu-HU"
},
{
"value": "id-ID",
"title": "id-ID"
},
{
"value": "is-IS",
"title": "is-IS"
},
{
"value": "it-IT",
"title": "it-IT"
},
{
"value": "ja-JP",
"title": "ja-JP"
},
{
"value": "ka-GE",
"title": "ka-GE"
},
{
"value": "kk-KZ",
"title": "kk-KZ"
},
{
"value": "ko-KR",
"title": "ko-KR"
},
{
"value": "lt-LT",
"title": "lt-LT"
},
{
"value": "lv-LV",
"title": "lv-LV"
},
{
"value": "mk-MK",
"title": "mk-MK"
},
{
"value": "ms-MY",
"title": "ms-MY"
},
{
"value": "nb-NO",
"title": "nb-NO"
},
{
"value": "nl-NL",
"title": "nl-NL"
},
{
"value": "nn-NO",
"title": "nn-NO"
},
{
"value": "pl-PL",
"title": "pl-PL"
},
{
"value": "pt-BR",
"title": "pt-BR"
},
{
"value": "pt-PT",
"title": "pt-PT"
},
{
"value": "ro-RO",
"title": "ro-RO"
},
{
"value": "ru-RU",
"title": "ru-RU"
},
{
"value": "sk-SK",
"title": "sk-SK"
},
{
"value": "sl-SL",
"title": "sl-SL"
},
{
"value": "sq-AL",
"title": "sq-AL"
},
{
"value": "sr-Latn-RS",
"title": "sr-Latn-RS"
},
{
"value": "sv-SE",
"title": "sv-SE"
},
{
"value": "th-TH",
"title": "th-TH"
},
{
"value": "tr-TR",
"title": "tr-TR"
},
{
"value": "uk-UA",
"title": "uk-UA"
},
{
"value": "vi-VN",
"title": "vi-VN"
},
{
"value": "zh-CN",
"title": "zh-CN"
},
{
"value": "zh-TW",
"title": "zh-TW"
}
],
"type": "string",
"name": "MeetingInviteLanguages",
"title": "Meeting Invite Languages"
},
"LiveInterpretationEnabledType": {
"description": "Enables the use of RTMP-In in Teams meetings.",
"choices": [
{
"description": "If you would like users to be able to use interpretation in meetings but by default it is disabled.",
"value": "DisabledUserOverride",
"title": "DisabledUserOverride"
},
{
"description": "Prevents the option to be enabled in Meeting Options.",
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "LiveInterpretationEnabledType",
"title": "Live Interpretation Enabled Type"
},
"RecordingStorageMode": {
"choices": [
{
"value": "Stream",
"title": "Stream"
},
{
"value": "OneDriveForBusiness",
"title": "OneDriveForBusiness"
}
],
"type": "string",
"name": "RecordingStorageMode",
"title": "Recording Storage Mode"
},
"AllowScreenContentDigitization": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "AllowScreenContentDigitization",
"title": "Allow Screen Content Digitization"
},
"AllowWatermarkForCameraVideo": {
"description": "This setting allows scheduling meetings with watermarking for video enabled.",
"type": "boolean",
"name": "AllowWatermarkForCameraVideo",
"title": "Allow Watermark For Camera Video"
},
"ScreenSharingMode": {
"choices": [
{
"value": "EntireScreen",
"title": "Entire screen"
},
{
"value": "SingleApplication",
"title": "Single application"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "ScreenSharingMode",
"title": "Screen Sharing"
},
"AllowAnonymousUsersToDialOut": {
"description": "Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out.",
"type": "boolean",
"name": "AllowAnonymousUsersToDialOut",
"title": "Allow Anonymous Users To Dial Out"
},
"AllowExternalParticipantGiveRequestControl": {
"description": "Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting.",
"type": "boolean",
"name": "AllowExternalParticipantGiveRequestControl",
"title": "External participants can give or request control"
},
"AllowIPVideo": {
"description": "Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video.",
"type": "boolean",
"name": "AllowIPVideo",
"title": "Video conferencing"
},
"SpeakerAttributionMode": {
"choices": [
{
"value": "EnabledUserOverride",
"title": "EnabledUserOverride"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"name": "SpeakerAttributionMode",
"title": "Speaker Attribution Mode"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/add/ |
|
The GUI Add form of device/msteamsonline/CsTeamsMeetingPolicy 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/msteamsonline/CsTeamsMeetingPolicy | 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/msteamsonline/CsTeamsMeetingPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid1]", "/api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]&format=json
| 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": 9
},
"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": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"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": [
"add",
"remove",
"list",
"get",
"move",
"update",
"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"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "655efcc840d96fe47c24c479",
"meta": {
"tags": [],
"cached": true,
"title": "AllDay",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "655efcc840d96fe47c24c479",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efcc840d96fe47c24c479/?model_type=device/msteamsonline/CsTeamsMeetingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efcc840d96fe47c24c479"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"AllowParticipantGiveRequestControl": true,
"AllowBreakoutRooms": true,
"AllowSharedNotes": true,
"hierarchy": "655ef9d340d96fe47c238be3",
"StreamingAttendeeMode": "Disabled",
"AllowPSTNUsersToBypassLobby": false,
"AllowMeetNow": true,
"AllowPrivateMeetNow": true,
"AllowMeetingReactions": true,
"AllowCloudRecording": true,
"DesignatedPresenterRoleMode": "EveryoneUserOverride",
"AllowEngagementReport": "Enabled",
"EnrollUserOverride": "Disabled",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"AllowMeetingRegistration": true,
"AllowAnonymousUsersToStartMeeting": false,
"PreferredMeetingProviderForIslandsMode": "TeamsAndSfb",
"AllowChannelMeetingScheduling": true,
"AllowTrackingInReport": "Enabled",
"AllowScreenContentDigitization": "Enabled",
"RoomAttributeUserOverride": "Off",
"AllowRecordingStorageOutsideRegion": false,
"IPAudioMode": "EnabledOutgoingIncoming",
"AllowOutlookAddIn": true,
"MeetingChatEnabledType": "Enabled",
"AllowTranscription": false,
"MediaBitRateKb": 50000,
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "AllDay",
"AllowPrivateMeetingScheduling": true,
"ScreenSharingMode": "EntireScreen",
"AllowIPAudio": true,
"LiveCaptionsEnabledType": "DisabledUserOverride",
"AllowPowerPointSharing": true,
"AllowNDIStreaming": false,
"IPVideoMode": "EnabledOutgoingIncoming",
"VideoFiltersMode": "AllFilters",
"AutoAdmittedUsers": "EveryoneInCompany",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild",
"AllowIPVideo": true,
"WhoCanRegister": "EveryoneInCompany",
"AllowWhiteboard": true,
"TeamsCameraFarEndPTZMode": "Disabled",
"AllowAnonymousUsersToDialOut": false,
"AllowExternalParticipantGiveRequestControl": false,
"RecordingStorageMode": "OneDriveForBusiness",
"SpeakerAttributionMode": "EnabledUserOverride"
}
},
{
"pkid": "655efcc940d96fe47c24c493",
"meta": {
"tags": [],
"cached": true,
"title": "AllOff",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efcc940d96fe47c24c493",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efcc940d96fe47c24c493/?model_type=device/msteamsonline/CsTeamsMeetingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc940d96fe47c24c493/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efcc940d96fe47c24c493"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"AllowParticipantGiveRequestControl": false,
"AllowBreakoutRooms": true,
"AllowSharedNotes": false,
"hierarchy": "655ef9d340d96fe47c238be3",
"StreamingAttendeeMode": "Disabled",
"AllowPSTNUsersToBypassLobby": false,
"AllowMeetNow": false,
"AllowPrivateMeetNow": false,
"AllowMeetingReactions": true,
"AllowCloudRecording": false,
"DesignatedPresenterRoleMode": "EveryoneUserOverride",
"AllowEngagementReport": "Enabled",
"EnrollUserOverride": "Disabled",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"AllowMeetingRegistration": true,
"AllowAnonymousUsersToStartMeeting": false,
"PreferredMeetingProviderForIslandsMode": "TeamsAndSfb",
"AllowChannelMeetingScheduling": false,
"AllowTrackingInReport": "EnabledUserOverride",
"AllowScreenContentDigitization": "Enabled",
"RoomAttributeUserOverride": "Off",
"AllowRecordingStorageOutsideRegion": false,
"IPAudioMode": "EnabledOutgoingIncoming",
"AllowOutlookAddIn": false,
"MeetingChatEnabledType": "Disabled",
"AllowTranscription": false,
"MediaBitRateKb": 50000,
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "AllOff",
"AllowPrivateMeetingScheduling": false,
"ScreenSharingMode": "Disabled",
"AllowIPAudio": true,
"LiveCaptionsEnabledType": "Disabled",
"AllowPowerPointSharing": false,
"AllowNDIStreaming": false,
"IPVideoMode": "EnabledOutgoingIncoming",
"VideoFiltersMode": "AllFilters",
"AutoAdmittedUsers": "EveryoneInCompany",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild",
"AllowIPVideo": false,
"WhoCanRegister": "Everyone",
"AllowWhiteboard": false,
"TeamsCameraFarEndPTZMode": "Disabled",
"AllowAnonymousUsersToDialOut": false,
"AllowExternalParticipantGiveRequestControl": false,
"RecordingStorageMode": "OneDriveForBusiness",
"SpeakerAttributionMode": "EnabledUserOverride"
}
},
{
"pkid": "655efccd40d96fe47c24c619",
"meta": {
"tags": [],
"cached": true,
"title": "AllOn",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efccd40d96fe47c24c619",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/",
"class": "delete",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/655efccd40d96fe47c24c619/?model_type=device/msteamsonline/CsTeamsMeetingPolicy",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efccd40d96fe47c24c619/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efccd40d96fe47c24c619"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"AllowParticipantGiveRequestControl": true,
"AllowBreakoutRooms": true,
"AllowSharedNotes": true,
"hierarchy": "655ef9d340d96fe47c238be3",
"StreamingAttendeeMode": "Disabled",
"AllowPSTNUsersToBypassLobby": false,
"AllowMeetNow": true,
"AllowPrivateMeetNow": true,
"AllowMeetingReactions": true,
"AllowCloudRecording": true,
"DesignatedPresenterRoleMode": "EveryoneUserOverride",
"AllowEngagementReport": "Enabled",
"EnrollUserOverride": "Disabled",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"AllowMeetingRegistration": true,
"AllowAnonymousUsersToStartMeeting": false,
"PreferredMeetingProviderForIslandsMode": "TeamsAndSfb",
"AllowChannelMeetingScheduling": true,
"Description": "Do not assign. This policy is same as global defaults and would be deprecated",
"AllowTrackingInReport": "EnabledUserOverride",
"AllowScreenContentDigitization": "Enabled",
"RoomAttributeUserOverride": "Off",
"AllowRecordingStorageOutsideRegion": false,
"IPAudioMode": "EnabledOutgoingIncoming",
"AllowOutlookAddIn": true,
"MeetingChatEnabledType": "Enabled",
"AllowTranscription": false,
"MediaBitRateKb": 50000,
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "AllOn",
"AllowPrivateMeetingScheduling": true,
"ScreenSharingMode": "EntireScreen",
"AllowIPAudio": true,
"LiveCaptionsEnabledType": "DisabledUserOverride",
"AllowPowerPointSharing": true,
"AllowNDIStreaming": false,
"IPVideoMode": "EnabledOutgoingIncoming",
"VideoFiltersMode": "AllFilters",
"AutoAdmittedUsers": "EveryoneInCompany",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild",
"AllowIPVideo": true,
"WhoCanRegister": "Everyone",
"AllowWhiteboard": true,
"TeamsCameraFarEndPTZMode": "Disabled",
"AllowAnonymousUsersToDialOut": false,
"AllowExternalParticipantGiveRequestControl": false,
"RecordingStorageMode": "OneDriveForBusiness",
"SpeakerAttributionMode": "EnabledUserOverride"
}
}
]
}
(Show the first instance)
{
"pkid": "655efcc840d96fe47c24c479",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AllDay",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"self": [
{
"pkid": "655efcc840d96fe47c24c479",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efcc840d96fe47c24c479/?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/655efcc840d96fe47c24c479/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/+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/655efcc840d96fe47c24c479/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/655efcc840d96fe47c24c479/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efcc840d96fe47c24c479"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"AllowParticipantGiveRequestControl": true,
"AllowBreakoutRooms": true,
"AllowSharedNotes": true,
"hierarchy": "655ef9d340d96fe47c238be3",
"StreamingAttendeeMode": "Disabled",
"AllowPSTNUsersToBypassLobby": false,
"AllowMeetNow": true,
"AllowPrivateMeetNow": true,
"AllowMeetingReactions": true,
"AllowCloudRecording": true,
"DesignatedPresenterRoleMode": "EveryoneUserOverride",
"AllowEngagementReport": "Enabled",
"EnrollUserOverride": "Disabled",
"AllowMeetingRegistration": true,
"AllowAnonymousUsersToStartMeeting": false,
"PreferredMeetingProviderForIslandsMode": "TeamsAndSfb",
"AllowChannelMeetingScheduling": true,
"AllowTrackingInReport": "Enabled",
"AllowScreenContentDigitization": "Enabled",
"RoomAttributeUserOverride": "Off",
"AllowRecordingStorageOutsideRegion": false,
"IPAudioMode": "EnabledOutgoingIncoming",
"AllowOutlookAddIn": true,
"MeetingChatEnabledType": "Enabled",
"AllowTranscription": false,
"MediaBitRateKb": 50000,
"Identity": "AllDay",
"AllowPrivateMeetingScheduling": true,
"ScreenSharingMode": "EntireScreen",
"AllowIPAudio": true,
"LiveCaptionsEnabledType": "DisabledUserOverride",
"AllowPowerPointSharing": true,
"AllowNDIStreaming": false,
"IPVideoMode": "EnabledOutgoingIncoming",
"VideoFiltersMode": "AllFilters",
"AutoAdmittedUsers": "EveryoneInCompany",
"AllowIPVideo": true,
"WhoCanRegister": "EveryoneInCompany",
"AllowWhiteboard": true,
"TeamsCameraFarEndPTZMode": "Disabled",
"AllowAnonymousUsersToDialOut": false,
"AllowExternalParticipantGiveRequestControl": false,
"RecordingStorageMode": "OneDriveForBusiness",
"SpeakerAttributionMode": "EnabledUserOverride"
}
}
| 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 |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/msteamsonline/CsTeamsMeetingPolicy/[pkid] | hierarchy=[hierarchy] |
| 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: |