[Index]
Model ref.: device/skypeforbusiness/CsNetworkBandwidthPolicyProfile
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": { "BWPolicyProfileID": { "__type_requested": "string", "required": false, "name": "BWPolicyProfileID", "title": "BWPolicyProfileID", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Description": { "__type_requested": "String", "required": false, "description": "A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "AudioBWSessionLimit": { "__type_requested": "String", "required": false, "description": "The maximum amount of bandwidth to allocate per audio session. Expressed in kbps. Value must be 40 or higher.\nIf you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter.\nDefault: If you supply a value to the AudioBWLimit parameter but not to AudioBWSessionLimit, AudioBWSessionLimit will default to 175.", "title": "AudioBWSessionLimit", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AudioBWSessionLimit" }, "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" }, "AudioBWLimit": { "__type_requested": "String", "required": false, "description": "The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start.\nExpressed in kbps. For example, a value of 1000 would signify 1000 kbps.\nIf you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter.\nDefault: If you supply a value to the AudioBWSessionLimit parameter but not to AudioBWLimit, AudioBWLimit will default to 0.", "title": "AudioBWLimit", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AudioBWLimit" }, "VideoBWLimit": { "__type_requested": "String", "required": false, "description": "The maximum amount of bandwidth to allocate for all video connections. If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start.\nExpressed in kbps. For example, a value of 1000 would signify 1000 kbps.\nIf you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter.\nDefault: If you supply a value to the VideoBWSessionLimit parameter but not to VideoBWLimit, VideoBWLimit will default to 0.", "title": "VideoBWLimit", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "VideoBWLimit" }, "VideoBWSessionLimit": { "__type_requested": "String", "required": false, "description": "The maximum amount of bandwidth to allocate per video session. Expressed in kbps. Value must be 100 or higher.\nIf you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter.\nDefault: If you supply a value to the VideoBWLimit parameter but not to VideoBWSessionLimit, VideoBWSessionLimit will default to 700.", "title": "VideoBWSessionLimit", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "VideoBWSessionLimit" }, "Identity": { "__type_requested": "System.String", "required": true, "description": "A string value that uniquely identifies the policy. All bandwidth policy profiles are created at the global scope. Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. Note that this value also populates the BWPolicyProfileID property of the profile.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "BWPolicy": { "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType]", "required": false, "description": "A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation.\nIf you supply a value to this parameter, you cannot supply a value to the AudioBWLimit, AudioBWSessionLimit, VideoBWLimit, or VideoBWSessionLimit parameter.\nObjects in the list can be created by calling the New-CsNetworkBWPolicy cmdlet.", "title": "BWPolicy", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "BWPolicy" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/add/ |
|
The GUI Add form of device/skypeforbusiness/CsNetworkBandwidthPolicyProfile 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/skypeforbusiness/CsNetworkBandwidthPolicyProfile/ | 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/skypeforbusiness/CsNetworkBandwidthPolicyProfile/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid1]", "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid1]", "/api/v0/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsNetworkBandwidthPolicyProfile |
|
{"hrefs": ["/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsNetworkBandwidthPolicyProfile |
|
{"hrefs": ["/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid1]", "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsNetworkBandwidthPolicyProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid1]", "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[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/skypeforbusiness/CsNetworkBandwidthPolicyProfile and the JSON format can be used to import instances of device/skypeforbusiness/CsNetworkBandwidthPolicyProfile.
GET http://[host-proxy]/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsNetworkBandwidthPolicyProfile | POST | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/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/skypeforbusiness/CsNetworkBandwidthPolicyProfile/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/ |
|
The device/skypeforbusiness/CsNetworkBandwidthPolicyProfile schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsNetworkBandwidthPolicyProfile instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?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/skypeforbusiness/CsNetworkBandwidthPolicyProfile/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/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/skypeforbusiness/CsNetworkBandwidthPolicyProfile", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/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/skypeforbusiness/CsNetworkBandwidthPolicyProfile/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsNetworkBandwidthPolicyProfile", "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": [ { "name": "Description", "title": "Description" }, { "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/skypeforbusiness/CsNetworkBandwidthPolicyProfile. | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsNetworkBandwidthPolicyProfile as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsNetworkBandwidthPolicyProfile | 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/skypeforbusiness/CsNetworkBandwidthPolicyProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[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/skypeforbusiness/CsNetworkBandwidthPolicyProfile and the JSON format can be used to import instances of device/skypeforbusiness/CsNetworkBandwidthPolicyProfile.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsNetworkBandwidthPolicyProfile instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsNetworkBandwidthPolicyProfile. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsNetworkBandwidthPolicyProfile/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |