API Reference for device/exchangehybrid/SiteMailboxProvisioningPolicy

Model ref.: device/exchangehybrid/SiteMailboxProvisioningPolicy

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "IssueWarningQuota": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe IssueWarningQuota parameter specifies the site mailbox size that triggers a warning message to the site mailbox. The default value is 4.5 GB.\nWhen you enter the value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.", 
               "title": "IssueWarningQuota", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "IssueWarningQuota"
          }, 
          "AdminDisplayName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "AdminDisplayName", 
               "title": "AdminDisplayName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "IgnoreDehydratedFlag": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "IgnoreDehydratedFlag", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "IgnoreDehydratedFlag"
          }, 
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "PSShowComputerName": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "PSShowComputerName", 
               "title": "PSShowComputerName", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ObjectClass": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", 
               "required": false, 
               "name": "ObjectClass", 
               "title": "ObjectClass", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "PSComputerName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "PSComputerName", 
               "title": "PSComputerName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Identity": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "Identity", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The Identity parameter specifies the identity of the site mailbox provisioning policy."
          }, 
          "DistinguishedName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "DistinguishedName", 
               "title": "DistinguishedName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "OriginatingServer": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OriginatingServer", 
               "title": "OriginatingServer", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Name": {
               "__type_requested": "String", 
               "required": true, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe Name parameter specifies the name of the provisioning policy that you are creating.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "MaxReceiveSize": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxReceiveSize parameter specifies the maximum size of email messages that can be received by the site mailbox. The default value is 36 MB.\nWhen you enter the value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.", 
               "title": "MaxReceiveSize", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "MaxReceiveSize"
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "Organization": {
               "__type_requested": "OrganizationIdParameter", 
               "required": false, 
               "description": "The Organization parameter is reserved for internal Microsoft use.", 
               "title": "Organization", 
               "__type_mapping_type": "Unknown", 
               "name": "Organization", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ExchangeVersion": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ExchangeVersion", 
               "title": "ExchangeVersion", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "IsDefault": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe IsDefault parameter specifies that the site mailbox provisioning policy is the default policy. You can have multiple policies, but only the default policy is followed when users create site mailboxes.", 
               "title": "IsDefault", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "IsDefault"
          }, 
          "DefaultAliasPrefixEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe DefaultAliasPrefixEnabled parameter specifies whether all new site mailboxes will have SM- prepended to the alias if the site mailbox is in an on-premises organization or will have SMO- prepended to the alias if the site mailbox is in an Exchange Online or Office365 organization. However, if a value has been specified for the AliasPrefix parameter, that value will be used even if this parameter is set to $true.\nFor example, if the DefaultAliasPrefixEnabled parameter is set to $true, the AliasPrefix parameter is set to $null, and an on-premises site mailbox is created named BugBash_2013, the alias for that site mailbox will be SM-BugBash_2013. If the AliasPrefix parameter is $null and the DefaultAliasPrefixEnabled parameter is $false, no prefix will be added for new site mailboxes.\nThis parameter accepts $true or $false. The default value is $true.", 
               "title": "DefaultAliasPrefixEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "DefaultAliasPrefixEnabled"
          }, 
          "AliasPrefix": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe AliasPrefix parameter allows you to configure a custom prefix that you want added to site mailbox aliases. If the AliasPrefix parameter is set to a valid, non-null string, each new site mailbox will have that string prepended to the alias. If the AliasPrefix parameter is set to $null and the DefaultAliasPrefixEnabled parameter is set to $true, the default prefix is used. If the AliasPrefix parameter is set to $null and the DefaultAliasPrefixEnabled parameter is set to $false, no prefix is used.", 
               "title": "AliasPrefix", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "AliasPrefix"
          }, 
          "DomainController": {
               "__type_requested": "Fqdn", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.", 
               "title": "DomainController", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DomainController"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "IsValid": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ProhibitSendReceiveQuota": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe ProhibitSendReceiveQuota parameter specifies the size at which the site mailbox can no longer send or receive messages. The default value is 5 GB.\nWhen you enter the value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.", 
               "title": "ProhibitSendReceiveQuota", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ProhibitSendReceiveQuota"
          }, 
          "WhenChanged": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChanged", 
               "title": "WhenChanged", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "WhenChangedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChangedUTC", 
               "title": "WhenChangedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "ObjectState": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "RunspaceId": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "RunspaceId", 
               "title": "RunspaceId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Guid": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "Guid", 
               "title": "Guid", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Id": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "Id", 
               "title": "Id", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }
     }, 
     "schema_version": "15312"
}

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

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

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

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

 GET http://[host-proxy]/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/?hierarchy=[hierarchy]

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

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

(The list will return 0 to 3 device/exchangehybrid/SiteMailboxProvisioningPolicy instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "15312", 
          "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/exchangehybrid/SiteMailboxProvisioningPolicy/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/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/exchangehybrid/SiteMailboxProvisioningPolicy", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/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/exchangehybrid/SiteMailboxProvisioningPolicy/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/exchangehybrid/SiteMailboxProvisioningPolicy", 
          "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": "Name", 
                    "title": "Name"
               }, 
               {
                    "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/exchangehybrid/SiteMailboxProvisioningPolicy.	GET	/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchangehybrid/SiteMailboxProvisioningPolicy 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/exchangehybrid/SiteMailboxProvisioningPolicy/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/exchangehybrid/SiteMailboxProvisioningPolicy/[pkid]	hierarchy=[hierarchy]

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

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

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

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

API Reference for device/exchangehybrid/SiteMailboxProvisioningPolicy

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge