[Index]
Model ref.: device/skypeforbusinesshybrid/CsConferencingPolicy
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": { "EnableOnlineMeetingPromptForLyncResources": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. The default value is False.", "title": "EnableOnlineMeetingPromptForLyncResources", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableOnlineMeetingPromptForLyncResources" }, "FileTransferBitRateKb": { "__type_requested": "Int64", "required": false, "description": "Bit rate (in kilobits) used for file transfers. The default value is 50000.", "title": "FileTransferBitRateKb", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "FileTransferBitRateKb" }, "AllowNonEnterpriseVoiceUsersToDialOut": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference.\nNote that dial-in conferencing is allowed even when this setting is False.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out.\nThe default value is False ($False).", "title": "AllowNonEnterpriseVoiceUsersToDialOut", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowNonEnterpriseVoiceUsersToDialOut" }, "AllowMultiView": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. However, the user can participate in other conferences where multiview is allowed.", "title": "AllowMultiView", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowMultiView" }, "ScopeClass": { "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", "required": false, "name": "ScopeClass", "title": "ScopeClass", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "EnableFileTransfer": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether file transfers to all the meeting participants are allowed during the meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. However, the user can take part in other conferences where file transfers are allowed.", "title": "EnableFileTransfer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableFileTransfer" }, "EnableP2PFileTransfer": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. The default value is True.\nThis setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not.", "title": "EnableP2PFileTransfer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableP2PFileTransfer" }, "DisablePowerPointAnnotations": { "__type_requested": "$true | $false", "required": false, "description": "When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. The default value is False, meaning that PowerPoint annotations are allowed.", "title": "DisablePowerPointAnnotations", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "DisablePowerPointAnnotations" }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provider explanatory text about the conferencing policy. For example, the Description might indicate the users the policy should be assigned to.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "ApplicationSharingMode": { "__type_requested": "string", "required": false, "name": "ApplicationSharingMode", "title": "ApplicationSharingMode", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AllowParticipantControl": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. However, the user can take part in other conferences where participant control is allowed.", "title": "AllowParticipantControl", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowParticipantControl" }, "AllowSharedNotes": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference.", "title": "AllowSharedNotes", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowSharedNotes" }, "AllowPolls": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not users are allowed to conduct online polls during a meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. However, the user can take part in other conferences where polls are allowed.", "title": "AllowPolls", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowPolls" }, "AllowExternalUserControl": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether external users (either anonymous users or federated users) are allowed to take control of shared applications or desktops. The default value is False.\nThis setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. That means that some users in a session might be allowed to give up control of a shared application or desktop to an external user while other users might not be allowed to give up control.", "title": "AllowExternalUserControl", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowExternalUserControl" }, "EnableAppDesktopSharing": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.EnableAppDesktopSharing", "required": false, "description": "Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. Allowed values are:\nDesktop. Users are allowed to share their entire desktop.\nSingleApplication. Users are allowed to share a single application.\nNone. Users are not allowed to share applications or their desktop.\nThis setting is enforced at the per-user level. That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so.\nThe default value is Desktop.", "title": "EnableAppDesktopSharing", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "EnableAppDesktopSharing" }, "EnableP2PRecording": { "__type_requested": "$true | $false", "required": false, "description": "If True, users will be able to record peer-to-peer conferencing sessions. The default value is False.\nThis setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not.", "title": "EnableP2PRecording", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableP2PRecording" }, "AllowConferenceRecording": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether users are allowed to record the meeting. The default value is False.\nThis setting applies to all users taking part in the conference.", "title": "AllowConferenceRecording", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowConferenceRecording" }, "VideoBitRateKb": { "__type_requested": "Int64", "required": false, "description": "Bit rate (in kilobits) used for video transmissions. The default value is 50000.\nThis setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions.", "title": "VideoBitRateKb", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "VideoBitRateKb" }, "EnableMultiViewJoin": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). This parameter will be ignored if multiview is not allowed in the conference being joined. This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not.", "title": "EnableMultiViewJoin", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableMultiViewJoin" }, "AllowExternalUsersToSaveContent": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides, and other meeting content. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. However, the user can take part in other conferences where external users are allowed to save content.", "title": "AllowExternalUsersToSaveContent", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowExternalUsersToSaveContent" }, "Identity": { "__type_requested": "string", "required": true, "description": "Unique identifier for the conferencing policy to be created. Conferencing policies can be created at the site or per-user scopes. To create a site policy, use syntax similar to this: -Identity site:Redmond. To create a per-user policy, use syntax similar to this: -Identity SalesConferencingPolicy.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "EnableP2PVideo": { "__type_requested": "$true | $false", "required": false, "description": "If True, users will be able to take part in peer-to-peer video conferencing sessions. The default value is False.\nThis setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to use video the session while the other user is not.", "title": "EnableP2PVideo", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableP2PVideo" }, "AllowAnonymousParticipantsInMeetings": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow anonymous participants. However, the user can take part in other conferences where anonymous participants are allowed.", "title": "AllowAnonymousParticipantsInMeetings", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowAnonymousParticipantsInMeetings" }, "AllowAnnotations": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True.\nNote that annotations are not archived along with other meeting content.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will include annotations. However, the user can participate in other conferences where annotations are allowed.", "title": "AllowAnnotations", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowAnnotations" }, "AudioBitRateKb": { "__type_requested": "UInt32", "required": false, "description": "Bit rate (in kilobits) used for audio transmissions. The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200.\nThis setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions.", "title": "AudioBitRateKb", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "AudioBitRateKb" }, "AppSharingBitRateKb": { "__type_requested": "Int64", "required": false, "description": "Bit rate (in kilobits) used for application sharing. The default value is 50000.", "title": "AppSharingBitRateKb", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "AppSharingBitRateKb" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "AllowIPAudio": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not computer audio is allowed in the meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. However, the user can take part in other conferences where IP audio is allowed.", "title": "AllowIPAudio", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowIPAudio" }, "AllowOfficeContent": { "__type_requested": "$true | $false", "required": false, "description": "When set to False, prevents users from using Office content in their conferences.", "title": "AllowOfficeContent", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowOfficeContent" }, "AllowLargeMeetings": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, all online meetings are treated as \"large meeting.\" With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default.\nThe default value is False ($False).", "title": "AllowLargeMeetings", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowLargeMeetings" }, "AllowUserToScheduleMeetingsWithAppSharing": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not users are allowed to organize meetings that include application sharing. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. However, the user can take part in other conferences where application sharing is allowed.", "title": "AllowUserToScheduleMeetingsWithAppSharing", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowUserToScheduleMeetingsWithAppSharing" }, "Anchor": { "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", "required": false, "name": "Anchor", "title": "Anchor", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AllowFederatedParticipantJoinAsSameEnterprise": { "__type_requested": "$true | $false", "required": false, "description": "When set to True ($True), allows federated meeting participants to join the meeting as though they were internal users rather than external users.", "title": "AllowFederatedParticipantJoinAsSameEnterprise", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowFederatedParticipantJoinAsSameEnterprise" }, "EnableDialInConferencing": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. However, the user can take part in other conferences where dial-in conferencing is allowed.", "title": "EnableDialInConferencing", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableDialInConferencing" }, "AllowQandA": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed.", "title": "AllowQandA", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowQandA" }, "EnableDataCollaboration": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. However, the user can take part in other conferences where data collaboration is allowed.", "title": "EnableDataCollaboration", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableDataCollaboration" }, "MaxMeetingSize": { "__type_requested": "UInt32", "required": false, "description": "Indicates the maximum number of people who are allowed to attend a meeting. After the maximum number of participants has been reached, anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250.\n250 is the maximum for shared pool deployments, based on Microsoft testing. For information about supporting meeting with more than 250 participants, see \"Microsoft Lync Server 2010 Support for Large Meetings\" at http://go.microsoft.com/fwlink/p/?linkId=242073 (http://go.microsoft.com/fwlink/p/?linkId=242073).\nThis setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. However, the user can take part in other conferences where additional participants are allowed.", "title": "MaxMeetingSize", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxMeetingSize" }, "TotalReceiveVideoBitRateKb": { "__type_requested": "Int64", "required": false, "description": "Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. The default value is 50000 kilobytes per second.", "title": "TotalReceiveVideoBitRateKb", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "TotalReceiveVideoBitRateKb" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new conferencing policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your Skype for Business Online tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", "title": "Tenant", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Tenant" }, "AllowAnonymousUsersToDialOut": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not anonymous users (unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning, the conferencing server telephones the user; when the user answers the phone, he or she will be joined to the conference.\nNote that dial-in conferencing is allowed even if this setting is False.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow anonymous participants to join the conference via dial-out phoning. However, the user can take part in other conferences where anonymous users can join via dial out.\nThe default value is False.", "title": "AllowAnonymousUsersToDialOut", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowAnonymousUsersToDialOut" }, "MaxVideoConferenceResolution": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MaxVideoConferenceResolution", "required": false, "description": "Indicates the maximum resolution for meeting video. Allowed values are:\nCIF. Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels.\nVGA. VGA has a resolution of 640 pixels by 480 pixels.\nThe default value is VGA.", "title": "MaxVideoConferenceResolution", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "MaxVideoConferenceResolution" }, "AllowExternalUsersToRecordMeeting": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. The default value is False.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. However, the user can take part in other conferences where external users are allowed to record meetings.\nNote that this setting takes effect only if the AllowConferenceRecording property is set to True.", "title": "AllowExternalUsersToRecordMeeting", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowExternalUsersToRecordMeeting" }, "AllowIPVideo": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not computer video is allowed in the meeting. The default value is True.\nThis setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. However, the user can take part in other conferences where IP video is allowed.", "title": "AllowIPVideo", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowIPVideo" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsConferencingPolicy 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/skypeforbusinesshybrid/CsConferencingPolicy/ | 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/skypeforbusinesshybrid/CsConferencingPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsConferencingPolicy |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsConferencingPolicy |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsConferencingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/[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/skypeforbusinesshybrid/CsConferencingPolicy and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsConferencingPolicy.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsConferencingPolicy | POST | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/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/skypeforbusinesshybrid/CsConferencingPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/ |
|
The device/skypeforbusinesshybrid/CsConferencingPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsConferencingPolicy instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?skip=0&limit=3&order_by=Description&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1150", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/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/skypeforbusinesshybrid/CsConferencingPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/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/skypeforbusinesshybrid/CsConferencingPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsConferencingPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsConferencingPolicy", "model_specific_actions": [ "get", "list", "powershell_grant", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusinesshybrid/CsConferencingPolicy. | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsConferencingPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsConferencingPolicy | 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/skypeforbusinesshybrid/CsConferencingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[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/skypeforbusinesshybrid/CsConferencingPolicy and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsConferencingPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsConferencingPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsConferencingPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Grant | POST | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/+powershell_grant/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsConferencingPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |