[Index]
Model ref.: device/sfb2015/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": "boolean",
"name": "EnableOnlineMeetingPromptForLyncResources",
"title": "Enable Online Meeting Prompt For Lync Resources"
},
"FileTransferBitRateKb": {
"type": "integer",
"name": "FileTransferBitRateKb",
"title": "File Transfer Bit Rate Kb"
},
"AllowNonEnterpriseVoiceUsersToDialOut": {
"type": "boolean",
"name": "AllowNonEnterpriseVoiceUsersToDialOut",
"title": "Allow Non Enterprise Voice Users To Dial Out"
},
"AllowMultiView": {
"type": "boolean",
"name": "AllowMultiView",
"title": "Allow Multi View"
},
"EnableReliableConferenceDeletion": {
"type": "boolean",
"name": "EnableReliableConferenceDeletion",
"title": "Enable Reliable Conference Deletion"
},
"EnableFileTransfer": {
"type": "boolean",
"name": "EnableFileTransfer",
"title": "Enable File Transfer"
},
"EnableP2PFileTransfer": {
"type": "boolean",
"name": "EnableP2PFileTransfer",
"title": "Enable P2P File Transfer"
},
"DisablePowerPointAnnotations": {
"type": "boolean",
"name": "DisablePowerPointAnnotations",
"title": "Disable Power Point Annotations"
},
"Description": {
"type": "string",
"name": "Description",
"title": "Description"
},
"EnableAppDesktopSharing": {
"type": "boolean",
"name": "EnableAppDesktopSharing",
"title": "Enable App Desktop Sharing"
},
"AllowParticipantControl": {
"type": "boolean",
"name": "AllowParticipantControl",
"title": "Allow Participant Control"
},
"AllowSharedNotes": {
"type": "boolean",
"name": "AllowSharedNotes",
"title": "Allow Shared Notes"
},
"AllowPolls": {
"type": "boolean",
"name": "AllowPolls",
"title": "Allow Polls"
},
"AllowExternalUserControl": {
"type": "boolean",
"name": "AllowExternalUserControl",
"title": "Allow External User Control"
},
"ApplicationSharingMode": {
"type": "string",
"name": "ApplicationSharingMode",
"title": "Application Sharing Mode"
},
"EnableP2PRecording": {
"type": "boolean",
"name": "EnableP2PRecording",
"title": "Enable P2P Recording"
},
"AllowConferenceRecording": {
"type": "boolean",
"name": "AllowConferenceRecording",
"title": "Allow Conference Recording"
},
"VideoBitRateKb": {
"type": "integer",
"name": "VideoBitRateKb",
"title": "Video Bit Rate Kb"
},
"EnableP2PFileTransferOutsideIntranet": {
"type": "boolean",
"name": "EnableP2PFileTransferOutsideIntranet",
"title": "Enable P2P File Transfer Outside Intranet"
},
"EnableMultiViewJoin": {
"type": "boolean",
"name": "EnableMultiViewJoin",
"title": "Enable Multi View Join"
},
"AllowExternalUsersToSaveContent": {
"type": "boolean",
"name": "AllowExternalUsersToSaveContent",
"title": "Allow External Users To Save Content"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"EnableP2PVideo": {
"type": "boolean",
"name": "EnableP2PVideo",
"title": "Enable P2P Video"
},
"AllowAnonymousParticipantsInMeetings": {
"type": "boolean",
"name": "AllowAnonymousParticipantsInMeetings",
"title": "Allow Anonymous Participants In Meetings"
},
"AllowAnnotations": {
"type": "boolean",
"name": "AllowAnnotations",
"title": "Allow Annotations"
},
"AudioBitRateKb": {
"type": "integer",
"name": "AudioBitRateKb",
"title": "Audio Bit Rate Kb"
},
"AppSharingBitRateKb": {
"type": "integer",
"name": "AppSharingBitRateKb",
"title": "App Sharing Bit Rate Kb"
},
"AllowIPAudio": {
"type": "boolean",
"name": "AllowIPAudio",
"title": "Allow IP Audio"
},
"AllowOfficeContent": {
"type": "boolean",
"name": "AllowOfficeContent",
"title": "Allow Office Content"
},
"AllowLargeMeetings": {
"type": "boolean",
"name": "AllowLargeMeetings",
"title": "Allow Large Meetings"
},
"AllowUserToScheduleMeetingsWithAppSharing": {
"type": "boolean",
"name": "AllowUserToScheduleMeetingsWithAppSharing",
"title": "Allow User To Schedule Meetings With App Sharing"
},
"AllowFederatedParticipantJoinAsSameEnterprise": {
"type": "boolean",
"name": "AllowFederatedParticipantJoinAsSameEnterprise",
"title": "Allow Federated Participant Join As Same Enterprise"
},
"EnableDialInConferencing": {
"type": "boolean",
"name": "EnableDialInConferencing",
"title": "Enable Dial In Conferencing"
},
"AllowQandA": {
"type": "boolean",
"name": "AllowQandA",
"title": "Allow Q and A"
},
"EnableDataCollaboration": {
"type": "boolean",
"name": "EnableDataCollaboration",
"title": "Enable Data Collaboration"
},
"MaxMeetingSize": {
"type": "integer",
"name": "MaxMeetingSize",
"title": "Max Meeting Size"
},
"TotalReceiveVideoBitRateKb": {
"type": "integer",
"name": "TotalReceiveVideoBitRateKb",
"title": "Total Receive Video Bit Rate Kb"
},
"AllowAnonymousUsersToDialOut": {
"type": "boolean",
"name": "AllowAnonymousUsersToDialOut",
"title": "Allow Anonymous Users To Dial Out"
},
"MaxVideoConferenceResolution": {
"type": "string",
"name": "MaxVideoConferenceResolution",
"title": "Max Video Conference Resolution"
},
"AllowExternalUsersToRecordMeeting": {
"type": "boolean",
"name": "AllowExternalUsersToRecordMeeting",
"title": "Allow External Users To Record Meeting"
},
"AllowIPVideo": {
"type": "boolean",
"name": "AllowIPVideo",
"title": "Allow IP Video"
}
},
"schema_version": "2015.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/sfb2015/CsConferencingPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/sfb2015/CsConferencingPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/sfb2015/CsConferencingPolicy/[pkid1]", "/api/v0/device/sfb2015/CsConferencingPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/sfb2015/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/sfb2015/CsConferencingPolicy |
|
{"hrefs": ["/api/device/sfb2015/CsConferencingPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/sfb2015/CsConferencingPolicy |
|
{"hrefs": ["/api/device/sfb2015/CsConferencingPolicy/[pkid1]", "/api/device/sfb2015/CsConferencingPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/sfb2015/CsConferencingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/sfb2015/CsConferencingPolicy/export/ |
|
{ "hrefs":["/api/device/sfb2015/CsConferencingPolicy/[pkid1]", "/api/device/sfb2015/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/sfb2015/CsConferencingPolicy and the JSON format can be used to import instances of device/sfb2015/CsConferencingPolicy.
GET http://[host-proxy]/api/device/sfb2015/CsConferencingPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/sfb2015/CsConferencingPolicy | POST | /api/device/sfb2015/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/sfb2015/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/sfb2015/CsConferencingPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/sfb2015/CsConferencingPolicy/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/sfb2015/CsConferencingPolicy/ |
|
The device/sfb2015/CsConferencingPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/sfb2015/CsConferencingPolicy instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/sfb2015/CsConferencingPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2015.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/sfb2015/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/sfb2015/CsConferencingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/sfb2015/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/sfb2015/CsConferencingPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/sfb2015/CsConferencingPolicy/+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/sfb2015/CsConferencingPolicy/+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/sfb2015/CsConferencingPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/sfb2015/CsConferencingPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/sfb2015/CsConferencingPolicy/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/sfb2015/CsConferencingPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/sfb2015/CsConferencingPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/sfb2015/CsConferencingPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/sfb2015/CsConferencingPolicy/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/sfb2015/CsConferencingPolicy",
"model_specific_actions": [
"list",
"get",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/sfb2015/CsConferencingPolicy. | GET | /api/device/sfb2015/CsConferencingPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/sfb2015/CsConferencingPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/sfb2015/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/sfb2015/CsConferencingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/sfb2015/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/sfb2015/CsConferencingPolicy and the JSON format can be used to import instances of device/sfb2015/CsConferencingPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/sfb2015/CsConferencingPolicy/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/sfb2015/CsConferencingPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/sfb2015/CsConferencingPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/sfb2015/CsConferencingPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/sfb2015/CsConferencingPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/sfb2015/CsConferencingPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |