API Reference for device/skypeforbusinesshybrid/CsConferencingConfiguration

Model ref.: device/skypeforbusinesshybrid/CsConferencingConfiguration

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "MaxBandwidthPerAppSharingServiceMb": {
               "__type_requested": "uint64", 
               "required": false, 
               "description": "Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. The default value is 375 megabytes.", 
               "title": "MaxBandwidthPerAppSharingServiceMb", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MaxBandwidthPerAppSharingServiceMb"
          }, 
          "ClientMediaPortRangeEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic.", 
               "title": "ClientMediaPortRangeEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ClientMediaPortRangeEnabled"
          }, 
          "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"
          }, 
          "ClientVideoPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350.", 
               "title": "ClientVideoPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientVideoPort"
          }, 
          "CloudPollServicePrimaryUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not currently used with Skype for Business Server 2015.", 
               "title": "CloudPollServicePrimaryUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "CloudPollServicePrimaryUrl"
          }, 
          "MaxUploadFileSizeMb": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. The default value is 500 megabytes.", 
               "title": "MaxUploadFileSizeMb", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MaxUploadFileSizeMb"
          }, 
          "ContentGracePeriod": {
               "__type_requested": "timespan", 
               "required": false, 
               "description": "Indicates how long conference content will remain on the server following the end of a meeting. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days use this syntax: -ContentGracePeriod 30.00:00:00.\nThe content grace period can be set to any value between 30 minutes (00:30:00) and 180 days (180.00:00:00). The default value is 15 days (15.00:00:00).", 
               "title": "ContentGracePeriod", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ContentGracePeriod"
          }, 
          "ClientAppSharingPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352.", 
               "title": "ClientAppSharingPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientAppSharingPortRange"
          }, 
          "CloudPollServiceSecondaryUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not currently used with Skype for Business Server 2015.", 
               "title": "CloudPollServiceSecondaryUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "CloudPollServiceSecondaryUrl"
          }, 
          "ClientFileTransferPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350.", 
               "title": "ClientFileTransferPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientFileTransferPort"
          }, 
          "ClientFileTransferPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following three ports are available for file transfers: 5350; 5351; 5352.", 
               "title": "ClientFileTransferPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientFileTransferPortRange"
          }, 
          "ClientMediaPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for client media. Use this parameter for Microsoft Office Communicator 2007 R2 clients. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350.", 
               "title": "ClientMediaPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientMediaPort"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "Unique identifier for the collection of conferencing configuration settings to be modified. To refer to a collection configured at the site scope, use syntax similar to this: -Identity \"site:Redmond\". To refer to a collection at the service scope, use syntax like the following: -Identity \"service:ConferencingServer:atl-cs-001.litwareinc.com\". Note the Web Conferencing service is the only service that can host these configuration settings.", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "ClientMediaPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for client media. (The default value is 40.) Use this parameter for Office Communicator 2007 R2 clients. To determine the actual ports used for client media, use this value and the ClientMediaPort value. For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set to 3, then the following three ports are available for client media: 5350; 5351; 5352.", 
               "title": "ClientMediaPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientMediaPortRange"
          }, 
          "ClientAudioPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350.", 
               "title": "ClientAudioPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientAudioPort"
          }, 
          "ClientAudioPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following 3 ports are available for client audio: 5350; 5351; 5352.", 
               "title": "ClientAudioPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientAudioPortRange"
          }, 
          "HelpdeskExternalUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "URL where external users who click Help during a conference will be directed.", 
               "title": "HelpdeskExternalUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "HelpdeskExternalUrl"
          }, 
          "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"
          }, 
          "ConsoleDownloadInternalUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "URL where internal users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server 2015 pool.", 
               "title": "ConsoleDownloadInternalUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ConsoleDownloadInternalUrl"
          }, 
          "ClientSipDynamicPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100.", 
               "title": "ClientSipDynamicPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientSipDynamicPort"
          }, 
          "Organization": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Name of the organization hosting the conference.", 
               "title": "Organization", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Organization"
          }, 
          "ClientVideoPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following three ports are available for client video: 5350; 5351; 5352.", 
               "title": "ClientVideoPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientVideoPortRange"
          }, 
          "ClientAppSharingPort": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350.", 
               "title": "ClientAppSharingPort", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ClientAppSharingPort"
          }, 
          "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"
          }, 
          "HelpdeskInternalUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "URL where internal users who click Help during a conference will be directed.", 
               "title": "HelpdeskInternalUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "HelpdeskInternalUrl"
          }, 
          "MaxContentStorageMb": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Maximum amount of file space (in megabytes) allowed for the storage of conference content. MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. The default value is 500.", 
               "title": "MaxContentStorageMb", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MaxContentStorageMb"
          }, 
          "ClientSipDynamicPortRange": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following three ports are available for client media: 7100; 7101; 7102.", 
               "title": "ClientSipDynamicPortRange", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "ClientSipDynamicPortRange"
          }, 
          "ConsoleDownloadExternalUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "URL where external users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server 2015 pool.", 
               "title": "ConsoleDownloadExternalUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ConsoleDownloadExternalUrl"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusinesshybrid/CsConferencingConfiguration 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/CsConferencingConfiguration/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/CsConferencingConfiguration/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/skypeforbusinesshybrid/CsConferencingConfiguration
```
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/skypeforbusinesshybrid/CsConferencingConfiguration device/skypeforbusinesshybrid/CsConferencingConfiguration schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsConferencingConfiguration	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsConferencingConfiguration	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsConferencingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[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/CsConferencingConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsConferencingConfiguration.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/skypeforbusinesshybrid/CsConferencingConfiguration:

 GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsConferencingConfiguration	POST	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/skypeforbusinesshybrid/CsConferencingConfiguration	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusinesshybrid/CsConferencingConfiguration schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusinesshybrid/CsConferencingConfiguration instances)

GET http://[host]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?skip=0&limit=3&order_by=None&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/CsConferencingConfiguration/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/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/CsConferencingConfiguration", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/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/CsConferencingConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusinesshybrid/CsConferencingConfiguration", 
          "model_specific_actions": [
               "get", 
               "list", 
               "add", 
               "remove", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/skypeforbusinesshybrid/CsConferencingConfiguration.	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusinesshybrid/CsConferencingConfiguration as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[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/CsConferencingConfiguration/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/skypeforbusinesshybrid/CsConferencingConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsConferencingConfiguration	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/CsConferencingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusinesshybrid/CsConferencingConfiguration instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/skypeforbusinesshybrid/CsConferencingConfiguration.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/skypeforbusinesshybrid/CsConferencingConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/skypeforbusinesshybrid/CsConferencingConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge