API Reference for device/skypeforbusiness/CsClientVersionPolicyRule

Model ref.: device/skypeforbusiness/CsClientVersionPolicyRule

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/skypeforbusiness/CsClientVersionPolicyRule/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "MajorVersion": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "Major version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. Major versions equate to primary releases of the software. You must assign a value to the MajorVersion property any time you create a new rule.", 
               "title": "MajorVersion", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MajorVersion"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Enables administrators to provide additional information about the client version rule. For example, the Description might include information about who to contact if you believe the rule should be changed.", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "Parent": {
               "__type_requested": "String", 
               "required": true, 
               "description": "Scope information for the new rule. To use the Parent parameter and create a new rule for the global policy, use this syntax: -Parent global. To create a new rule for a site policy, use syntax similar to this: -Parent \"site:Redmond\". To create a new rule for a service policy, use syntax similar to this: -parent \"Registrar:atl-cs-001.litwareinc.com\". To create a new rule for a per-user policy, use syntax similar to this: -Parent \"RedmondClientVersionPolicy\".\nYou must use either the Identity parameter or both the Parent and RuleId parameters when creating a new rule.", 
               "title": "Parent", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Parent"
          }, 
          "RuleId": {
               "__type_requested": "String", 
               "required": true, 
               "description": "Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command:\n$x = [guid]::NewGuid()", 
               "title": "RuleId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "RuleId"
          }, 
          "Priority": {
               "__type_requested": "Int32", 
               "required": false, 
               "description": "Relative priority of the rule. Rules are processed in priority order, with the rule that has priority 0 being processed first, the rule that has priority 1 being processed second, and so on. If you assign a priority that is already in use, the new rule will use that priority and other rules will be renumbered accordingly.", 
               "title": "Priority", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "Priority"
          }, 
          "Enabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether or not the client version rule is to be used. If the Enabled property is set to False ($False), then the rule will be ignored any time a user attempts to log on with the specified software. The default value is True.", 
               "title": "Enabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "Enabled"
          }, 
          "BuildNumber": {
               "__type_requested": "System.Nullable[uint16]", 
               "required": false, 
               "description": "Build number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the BuildNumber is 6362. Build numbers represent internal versions of the software during the development process, and help to ensure that you are using the final release version as opposed to a pre-release version.", 
               "title": "BuildNumber", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "BuildNumber"
          }, 
          "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"
          }, 
          "QfeNumber": {
               "__type_requested": "System.Nullable[uint16]", 
               "required": false, 
               "description": "Quick fix engineering number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the QfeNumber is 111. QFE numbers represent planned updates to an application that are made available after the software's official release.", 
               "title": "QfeNumber", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "QfeNumber"
          }, 
          "ActionUrl": {
               "__type_requested": "String", 
               "required": false, 
               "description": "URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl.", 
               "title": "ActionUrl", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ActionUrl"
          }, 
          "UserAgentFullName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Enables administrators to provide a friendly name for the user agent. For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client.", 
               "title": "UserAgentFullName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "UserAgentFullName"
          }, 
          "Tenant": {
               "__type_requested": "Guid", 
               "required": false, 
               "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy rule 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"
          }, 
          "UserAgent": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Designator used to identify the software client. For example, OC is the user agent designation for Communicator.", 
               "title": "UserAgent", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "UserAgent"
          }, 
          "Action": {
               "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Action", 
               "required": false, 
               "description": "Action to be taken any time the rule is triggered (that is, any time someone attempts to log on by using the specified software). Valid values are:\nAllow. The user will be allowed to log on.\nAllowWithUrl. The user will be allowed to log on, and a message will be displayed pointing him or her to a URL where the latest version of Lync can be downloaded and installed.\nAllowAndUpgrade. The user will be allowed to log on, and his or her copy of Communicator will automatically be upgraded to the latest version of Lync.\nBlock. The user will not be allowed to log on.\nBlockWithUrl. The user will not be allowed to log on, but a message will be displayed pointing him or her to a URL where the latest version of Lync can be downloaded and installed.\nBlockAndUpgrade. The user will not be allowed to log on, but his or her copy of Communicator will automatically be upgraded to the latest version of Lync. The user can then try to log on by using the new client application.", 
               "title": "Action", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "Action"
          }, 
          "CompareOp": {
               "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.CompareOp", 
               "required": false, 
               "description": "Comparison operator used to determine if the client software attempting to log on was released before, after, or at the same time as the version specified in the rule. Valid values are:\nEQL (equal to)\nNEQ (not equal to)\nGTR (greater than)\nGEQ (greater than or equal to)\nLSS (less than)\nLEQ (less than or equal to)", 
               "title": "CompareOp", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "CompareOp"
          }, 
          "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"
          }, 
          "Identity": {
               "__type_requested": "System.String", 
               "required": true, 
               "description": "Unique identifier for the client version policy rule to be created. The Identity of a client version policy rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83.\nInstead of using the Identity parameter you can use the Parent and RuleId parameters to have the New-CsClientVerisonPolicyRule cmdlet create the Identity for you.", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "MinorVersion": {
               "__type_requested": "System.Nullable[uint16]", 
               "required": false, 
               "description": "Minor version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. Minor versions equate to interim releases of the software.", 
               "title": "MinorVersion", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MinorVersion"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusiness/CsClientVersionPolicyRule/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusiness/CsClientVersionPolicyRule 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/CsClientVersionPolicyRule/	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/skypeforbusiness/CsClientVersionPolicyRule/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusiness/CsClientVersionPolicyRule/[pkid1]", "/api/device/skypeforbusiness/CsClientVersionPolicyRule/[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/skypeforbusiness/CsClientVersionPolicyRule
```
GET http://[host-proxy]/api/device/skypeforbusiness/CsClientVersionPolicyRule/?hierarchy=[hierarchy]&format=json
```

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

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusiness/CsClientVersionPolicyRule/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsClientVersionPolicyRule/[pkid1]", "/api/v0/device/skypeforbusiness/CsClientVersionPolicyRule/[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/skypeforbusiness/CsClientVersionPolicyRule/?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/skypeforbusiness/CsClientVersionPolicyRule	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsClientVersionPolicyRule/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusiness/CsClientVersionPolicyRule	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsClientVersionPolicyRule/[pkid1]", "/api/device/skypeforbusiness/CsClientVersionPolicyRule/[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/skypeforbusiness/CsClientVersionPolicyRule/?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/skypeforbusiness/CsClientVersionPolicyRule; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusiness/CsClientVersionPolicyRule/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusiness/CsClientVersionPolicyRule/[pkid1]", "/api/device/skypeforbusiness/CsClientVersionPolicyRule/[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/CsClientVersionPolicyRule and the JSON format can be used to import instances of device/skypeforbusiness/CsClientVersionPolicyRule.

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

 GET http://[host-proxy]/api/device/skypeforbusiness/CsClientVersionPolicyRule/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusiness/CsClientVersionPolicyRule/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/skypeforbusiness/CsClientVersionPolicyRule/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/skypeforbusiness/CsClientVersionPolicyRule/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusiness/CsClientVersionPolicyRule schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusiness/CsClientVersionPolicyRule instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Description", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/?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/CsClientVersionPolicyRule/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/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/CsClientVersionPolicyRule", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/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/CsClientVersionPolicyRule/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusiness/CsClientVersionPolicyRule/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusiness/CsClientVersionPolicyRule", 
          "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": "19.3.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/skypeforbusiness/CsClientVersionPolicyRule.	GET	/api/device/skypeforbusiness/CsClientVersionPolicyRule/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusiness/CsClientVersionPolicyRule 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/skypeforbusiness/CsClientVersionPolicyRule/[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/CsClientVersionPolicyRule/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusiness/CsClientVersionPolicyRule/[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/skypeforbusiness/CsClientVersionPolicyRule

GET http://[host-proxy]/api/device/skypeforbusiness/CsClientVersionPolicyRule/?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/skypeforbusiness/CsClientVersionPolicyRule	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/CsClientVersionPolicyRule; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusiness/CsClientVersionPolicyRule/[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/skypeforbusiness/CsClientVersionPolicyRule/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusiness/CsClientVersionPolicyRule instance with [pkid].

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

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

API Reference for device/skypeforbusiness/CsClientVersionPolicyRule

GET http://[host-proxy]/api/device/skypeforbusiness/CsClientVersionPolicyRule/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/skypeforbusiness/CsClientVersionPolicyRule/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge