[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": {
"AllowAnonymousUsersToDialOut": {
"name": "AllowAnonymousUsersToDialOut",
"type": "boolean",
"title": "Allow Anonymous Users To Dial Out",
"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."
},
"AllowAnonymousUsersToStartMeeting": {
"name": "AllowAnonymousUsersToStartMeeting",
"type": "boolean",
"title": "Anonymous users and dial-in callers can start a meeting",
"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."
},
"AllowBreakoutRooms": {
"name": "AllowBreakoutRooms",
"type": "boolean",
"title": "Allow Breakout Rooms",
"description": "Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality."
},
"AllowChannelMeetingScheduling": {
"name": "AllowChannelMeetingScheduling",
"type": "boolean",
"title": "Channel meeting scheduling",
"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."
},
"AllowCloudRecording": {
"name": "AllowCloudRecording",
"type": "boolean",
"title": "Meeting Recording",
"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."
},
"AllowEngagementReport": {
"name": "AllowEngagementReport",
"type": "string",
"title": "Attendance report",
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"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."
},
"AllowExternalParticipantGiveRequestControl": {
"name": "AllowExternalParticipantGiveRequestControl",
"type": "boolean",
"title": "External participants can give or request control",
"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."
},
"AllowIPAudio": {
"name": "AllowIPAudio",
"type": "boolean",
"title": "Allow IP Audio"
},
"AllowIPVideo": {
"name": "AllowIPVideo",
"type": "boolean",
"title": "Video conferencing",
"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."
},
"AllowMeetNow": {
"name": "AllowMeetNow",
"type": "boolean",
"title": "Meet now in channel settings",
"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."
},
"AllowMeetingReactions": {
"name": "AllowMeetingReactions",
"type": "boolean",
"title": "Reactions",
"description": "Set to false to disable Meeting Reactions."
},
"AllowMeetingRegistration": {
"name": "AllowMeetingRegistration",
"type": "boolean",
"title": "Meeting Registration",
"description": "Controls if a user can create a webinar meeting. The default value is True."
},
"AllowNDIStreaming": {
"name": "AllowNDIStreaming",
"type": "boolean",
"title": "Broadcast production with NDI and SDI hardware",
"description": "This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network."
},
"AllowOutlookAddIn": {
"name": "AllowOutlookAddIn",
"type": "boolean",
"title": "Outlook Add-In",
"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."
},
"AllowPSTNUsersToBypassLobby": {
"name": "AllowPSTNUsersToBypassLobby",
"type": "boolean",
"title": "People dialing in can bypass the lobby",
"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."
},
"AllowParticipantGiveRequestControl": {
"name": "AllowParticipantGiveRequestControl",
"type": "boolean",
"title": "Participants can give or request control",
"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."
},
"AllowPowerPointSharing": {
"name": "AllowPowerPointSharing",
"type": "boolean",
"title": "PowerPoint Live",
"description": "Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit."
},
"AllowPrivateMeetNow": {
"name": "AllowPrivateMeetNow",
"type": "boolean",
"title": "Meet now in private meetings",
"description": "This setting controls whether a user can start an ad hoc private meeting."
},
"AllowPrivateMeetingScheduling": {
"name": "AllowPrivateMeetingScheduling",
"type": "boolean",
"title": "Private Meeting Scheduling",
"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."
},
"AllowRecordingStorageOutsideRegion": {
"name": "AllowRecordingStorageOutsideRegion",
"type": "boolean",
"title": "Store recordings outside of your country or region",
"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."
},
"AllowScreenContentDigitization": {
"name": "AllowScreenContentDigitization",
"type": "string",
"title": "Allow Screen Content Digitization",
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
]
},
"AllowSharedNotes": {
"name": "AllowSharedNotes",
"type": "boolean",
"title": "Shared Notes",
"description": "Determines whether users are allowed to take shared Meeting notes. Set this to TRUE to allow. Set this to FALSE to prohibit."
},
"AllowTrackingInReport": {
"name": "AllowTrackingInReport",
"type": "string",
"title": "Include attendees in the report",
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "EnabledUserOverride",
"title": "Enabled User Override"
},
{
"value": "DisabledUserOverride",
"title": "Disabled User Override"
}
]
},
"AllowTranscription": {
"name": "AllowTranscription",
"type": "boolean",
"title": "Transcription",
"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."
},
"AllowWhiteboard": {
"name": "AllowWhiteboard",
"type": "boolean",
"title": "Whiteboard",
"description": "Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit."
},
"AutoAdmittedUsers": {
"name": "AutoAdmittedUsers",
"type": "string",
"title": "Who can bypass the lobby",
"choices": [
{
"value": "EveryoneInCompany",
"title": "People in my org",
"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": "EveryoneInSameAndFederatedCompany",
"title": "People in my org, trusted orgs, and guests",
"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": "Everyone",
"title": "Everyone",
"description": "If you'd like to admit anonymous users by default."
},
{
"value": "OrganizerOnly",
"title": "Only organizers and co-organizers",
"description": "If you would like that only meeting organizers can bypass the lobby."
},
{
"value": "EveryoneInCompanyExcludingGuests",
"title": "People in my org and guests",
"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": "InvitedUsers",
"title": "People who were invited",
"description": "If you would like that only meeting organizers and invited users can bypass the lobby."
}
]
},
"Description": {
"name": "Description",
"type": "string",
"title": "Description",
"description": "Enables administrators to provide explanatory text about the meeting policy."
},
"DesignatedPresenterRoleMode": {
"name": "DesignatedPresenterRoleMode",
"type": "string",
"title": "Who can present",
"choices": [
{
"value": "EveryoneUserOverride",
"title": "Everyone",
"description": "All meeting participants can be presenters. This is the default value. This parameter corresponds to the Everyone setting in Teams."
},
{
"value": "EveryoneInCompanyUserOverride",
"title": "People in my organization",
"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": "OrganizerOnlyUserOverride",
"title": "Only organizers and co-organizers",
"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."
}
],
"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."
},
"EnrollUserOverride": {
"name": "EnrollUserOverride",
"type": "string",
"title": "Enroll User Override",
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
}
]
},
"IPAudioMode": {
"name": "IPAudioMode",
"type": "string",
"title": "Mode for IP audio",
"choices": [
{
"value": "EnabledOutgoingIncoming",
"title": "Outgoing and incoming audio enabled"
},
{
"value": "Disabled",
"title": "Not enabled"
}
],
"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."
},
"IPVideoMode": {
"name": "IPVideoMode",
"type": "string",
"title": "Mode for IP video",
"choices": [
{
"value": "EnabledOutgoingIncoming",
"title": "Outgoing and incoming video enabled"
},
{
"value": "Disabled",
"title": "Not enabled"
}
]
},
"Identity": {
"name": "Identity",
"type": "string",
"title": "Identity",
"required": true,
"readonly": true
},
"LiveCaptionsEnabledType": {
"name": "LiveCaptionsEnabledType",
"type": "string",
"title": "Live Captions",
"choices": [
{
"value": "DisabledUserOverride",
"title": "Off, but organizers and co-organizers can turn them on"
},
{
"value": "Disabled",
"title": "Off"
}
],
"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."
},
"MediaBitRateKb": {
"name": "MediaBitRateKb",
"type": "integer",
"title": "Media bit rate (Kbs)",
"description": "Determines the media bit rate for audio/video/app sharing transmissions in meetings."
},
"MeetingChatEnabledType": {
"name": "MeetingChatEnabledType",
"type": "string",
"title": "Meeting Chat",
"choices": [
{
"value": "Disabled",
"title": "Off"
},
{
"value": "Enabled",
"title": "On for everyone"
},
{
"value": "EnabledExceptAnonymous",
"title": "On for everyone but anonymous users"
}
],
"description": "Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous."
},
"PreferredMeetingProviderForIslandsMode": {
"name": "PreferredMeetingProviderForIslandsMode",
"type": "string",
"title": "Preferred Meeting Provider For Islands Mode",
"choices": [
{
"title": "TeamsAndSfb",
"value": "TeamsAndSfb"
},
{
"title": "Teams",
"value": "Teams"
}
],
"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."
},
"RecordingStorageMode": {
"name": "RecordingStorageMode",
"type": "string",
"title": "Recording Storage Mode",
"choices": [
{
"value": "Stream",
"title": "Stream"
},
{
"value": "OneDriveForBusiness",
"title": "OneDriveForBusiness"
}
]
},
"RoomAttributeUserOverride": {
"name": "RoomAttributeUserOverride",
"type": "string",
"title": "Room Attribute User Override",
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "Distinguish",
"title": "Distinguish"
},
{
"value": "Attribute",
"title": "Attribute"
}
]
},
"ScreenSharingMode": {
"name": "ScreenSharingMode",
"type": "string",
"title": "Screen Sharing",
"choices": [
{
"value": "EntireScreen",
"title": "Entire screen"
},
{
"value": "SingleApplication",
"title": "Single application"
},
{
"value": "Disabled",
"title": "Disabled"
}
]
},
"SpeakerAttributionMode": {
"name": "SpeakerAttributionMode",
"type": "string",
"title": "Speaker Attribution Mode",
"choices": [
{
"value": "EnabledUserOverride",
"title": "EnabledUserOverride"
},
{
"value": "Disabled",
"title": "Disabled"
}
]
},
"StreamingAttendeeMode": {
"name": "StreamingAttendeeMode",
"type": "string",
"title": "Streaming Attendee Mode",
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
}
],
"description": "Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality)."
},
"TeamsCameraFarEndPTZMode": {
"name": "TeamsCameraFarEndPTZMode",
"type": "string",
"title": "Teams Camera Far End PTZ Mode",
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "AutoAcceptInTenant",
"title": "AutoAcceptInTenant"
},
{
"value": "AutoAcceptAll",
"title": "AutoAcceptAll"
}
]
},
"VideoFiltersMode": {
"name": "VideoFiltersMode",
"type": "string",
"title": "Participants can use video effects",
"choices": [
{
"title": "Off",
"value": "NoFilters",
"description": "No filters are available."
},
{
"title": "Only Background Blur",
"value": "BlurOnly",
"description": "Background blur is the only option available (requires a processor with AVX2 support, see Hardware requirements for Microsoft Teams for more information)."
},
{
"title": "Only background blur and default backgrounds",
"value": "BlurAndDefaultBackgrounds",
"description": "Background blur and a list of pre-selected images are available."
},
{
"title": "All video effects",
"value": "AllFilters",
"description": "All filters are available, including custom images."
}
]
},
"WhoCanRegister": {
"name": "WhoCanRegister",
"type": "string",
"title": "Who Can Register",
"choices": [
{
"value": "Everyone",
"title": "Everyone"
},
{
"value": "EveryoneInCompany",
"title": "EveryoneInCompany"
}
]
},
"AllowNetworkConfigurationSettingsLookup": {
"name": "AllowNetworkConfigurationSettingsLookup",
"type": "boolean",
"title": "Network configuration lookup"
},
"LiveStreamingMode": {
"name": "LiveStreamingMode",
"type": "string",
"title": "Live Streaming",
"choices": [
{
"value": "Enabled",
"title": "On"
},
{
"value": "Disabled",
"title": "Off"
}
],
"description": "Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP)."
},
"AllowWatermarkForCameraVideo": {
"name": "AllowWatermarkForCameraVideo",
"type": "boolean",
"title": "Allow Watermark For Camera Video",
"description": "This setting allows scheduling meetings with watermarking for video enabled."
},
"ChannelRecordingDownload": {
"name": "ChannelRecordingDownload",
"type": "string",
"title": "Channel Recording Download",
"choices": [
{
"value": "Allow",
"title": "Allow",
"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": "Block",
"title": "Block",
"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."
}
],
"description": "Controls how channel meeting recordings are saved, permissioned, and who can download them."
},
"AllowAnonymousUsersToJoinMeeting": {
"name": "AllowAnonymousUsersToJoinMeeting",
"type": "boolean",
"title": "Anonymous users can join a meeting",
"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."
},
"AllowWatermarkForScreenSharing": {
"name": "AllowWatermarkForScreenSharing",
"type": "boolean",
"title": "Allow Watermark For Screen Sharing",
"description": "This setting allows scheduling meetings with watermarking for screen sharing enabled."
},
"MeetingInviteLanguages": {
"name": "MeetingInviteLanguages",
"type": "string",
"title": "Meeting Invite Languages",
"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"
}
],
"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."
},
"NewMeetingRecordingExpirationDays": {
"name": "NewMeetingRecordingExpirationDays",
"type": "integer",
"title": "Default expiration time",
"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."
},
"AllowCartCaptionsScheduling": {
"name": "AllowCartCaptionsScheduling",
"type": "string",
"title": "Allow Cart Captions Scheduling",
"choices": [
{
"value": "EnabledUserOverride",
"title": "EnabledUserOverride",
"description": "CART captions is available by default but a user can disable."
},
{
"value": "DisabledUserOverride",
"title": "DisabledUserOverride",
"description": "If you would like users to be able to use CART captions in meetings but by default it is disabled."
},
{
"value": "Disabled",
"title": "Disabled",
"description": "If you'd like to not allow CART captions in meeting."
}
],
"description": "Controls how channel meeting recordings are saved, permissioned, and who can download them."
},
"AllowedStreamingMediaInput": {
"name": "AllowedStreamingMediaInput",
"type": "string",
"title": "Allowed Streaming Media Input",
"choices": [
{
"value": "",
"title": ""
},
{
"value": "RTMP",
"title": "RTMP"
}
],
"description": "Enables the use of RTMP-In in Teams meetings."
},
"LiveInterpretationEnabledType": {
"name": "LiveInterpretationEnabledType",
"type": "string",
"title": "Live Interpretation Enabled Type",
"choices": [
{
"value": "DisabledUserOverride",
"title": "DisabledUserOverride",
"description": "If you would like users to be able to use interpretation in meetings but by default it is disabled."
},
{
"value": "Disabled",
"title": "Disabled",
"description": "Prevents the option to be enabled in Meeting Options."
}
],
"description": "Enables the use of RTMP-In in Teams meetings."
},
"InfoShownInReportMode": {
"name": "InfoShownInReportMode",
"type": "string",
"title": "Attendee information",
"choices": [
{
"value": "IdentityOnly",
"title": "Only show who attended"
},
{
"value": "FullInformation",
"title": "Show everything"
}
]
},
"RecordingsAutomaticExpire": {
"name": "RecordingsAutomaticExpire",
"type": "boolean",
"title": "Recordings Automatically Expire"
}
},
"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 |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsTeamsMeetingPolicy/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msteamsonline/CsTeamsMeetingPolicy/+tag_version/ |
|
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Identity",
"direction": "asc",
"current": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"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"
],
"schema_version": "2019.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsTeamsMeetingPolicy",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msteamsonline/CsTeamsMeetingPolicy/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"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 | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsMeetingPolicy/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msteamsonline/CsTeamsMeetingPolicy/transform/ |
|
| 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: |