[Index]
Model ref.: device/msexchangeonline/UserMailbox
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": {
"MaxSendSize": {
"title": "Maximum Send Size",
"type": "string",
"name": "MaxSendSize",
"description": "The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox.\\n\\nWhen you enter a value, qualify the value with one of the following units:\\n\\n B (bytes)\\n KB (kilobytes)\\n MB (megabytes)\\n GB (gigabytes)\\n\\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\\n\\nA valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited.\\n\\nIn Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license.\\n\\nIn Exchange Online, you use this parameter to configure the MaxSendSize value on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the MaxSendSize value for all new mailboxes that you create in the future.\\n\\nIn on-premises Exchange, the default value unlimited indicates the maximum send size for the mailbox is imposed elsewhere (for example, organization, server, or connector limits).\\n\\nBase64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB."
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
},
"UserPrincipalName": {
"type": "string",
"name": "UserPrincipalName",
"title": "User Principal Name"
},
"DisplayName": {
"type": "string",
"name": "DisplayName",
"title": "Display Name"
},
"CalendarPermissions": {
"items": {
"type": "object",
"properties": {
"User": {
"target_title": "DisplayName",
"target": "/api/device/msexchangeonline/UserMailbox/choices/?choice_title=DisplayName&field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "User",
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msexchangeonline/UserMailbox",
"type": "string",
"name": "User"
},
"AccessRights": {
"items": {
"type": "string",
"choices": [
{
"value": "Owner",
"title": "Owner"
},
{
"value": "PublishingEditor",
"title": "Publishing Editor"
},
{
"value": "Editor",
"title": "Editor"
},
{
"value": "PublishingAuthor",
"title": "Publishing Author"
},
{
"value": "Author",
"title": "Author"
},
{
"value": "NonEditingAuthor",
"title": "Non Editing Author"
},
{
"value": "Reviewer",
"title": "Reviewer"
},
{
"value": "Contributor",
"title": "Contributor"
},
{
"value": "AvailabilityOnly",
"title": "Availability Only"
},
{
"value": "LimitedDetails",
"title": "Limited Details"
},
{
"value": "None",
"title": "None"
},
{
"value": "CreateItems",
"title": "Create Items"
},
{
"value": "CreateSubfolders",
"title": "Create Subfolders"
},
{
"value": "DeleteAllItems",
"title": "Delete All Items"
},
{
"value": "DeleteOwnedItems",
"title": "Delete Owned Items"
},
{
"value": "EditAllItems",
"title": "Edit All Items"
},
{
"value": "EditOwnedItems",
"title": "Edit Owned Items"
},
{
"value": "FolderContact",
"title": "Folder Contact"
},
{
"value": "FolderOwner",
"title": "Folder Owner"
},
{
"value": "FolderVisible",
"title": "Folder Visible"
},
{
"value": "ReadItems",
"title": "Read Items"
}
]
},
"type": "array",
"name": "AccessRights",
"title": "Access Rights"
}
}
},
"type": "array",
"name": "CalendarPermissions",
"title": "Calendar Permissions"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array",
"name": "EmailAddresses",
"title": "Email Addresses"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"Permissions": {
"items": {
"type": "object",
"properties": {
"User": {
"target_title": "DisplayName",
"target": "/api/device/msexchangeonline/UserMailbox/choices/?choice_title=DisplayName&field=Name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "User",
"choices": [],
"target_attr": "Name",
"target_model_type": "device/msexchangeonline/UserMailbox",
"type": "string",
"name": "User"
},
"AccessRights": {
"items": {
"type": "string",
"choices": [
{
"value": "FullAccess",
"title": "Read And Manage"
},
{
"value": "SendAs",
"title": "Send As"
},
{
"value": "SendOnBehalfTo",
"title": "Send On Behalf"
}
]
},
"type": "array",
"name": "AccessRights",
"title": "Access Rights"
}
}
},
"type": "array",
"name": "Permissions",
"title": "Permissions"
}
},
"schema_version": "2.0.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msexchangeonline/UserMailbox/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msexchangeonline/UserMailbox/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msexchangeonline/UserMailbox/[pkid1]", "/api/v0/device/msexchangeonline/UserMailbox/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msexchangeonline/UserMailbox/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msexchangeonline/UserMailbox |
|
{"hrefs": ["/api/device/msexchangeonline/UserMailbox/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msexchangeonline/UserMailbox |
|
{"hrefs": ["/api/device/msexchangeonline/UserMailbox/[pkid1]", "/api/device/msexchangeonline/UserMailbox/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msexchangeonline/UserMailbox; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msexchangeonline/UserMailbox/export/ |
|
{ "hrefs":["/api/device/msexchangeonline/UserMailbox/[pkid1]", "/api/device/msexchangeonline/UserMailbox/[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/msexchangeonline/UserMailbox and the JSON format can be used to import instances of device/msexchangeonline/UserMailbox.
GET http://[host-proxy]/api/device/msexchangeonline/UserMailbox/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msexchangeonline/UserMailbox | POST | /api/device/msexchangeonline/UserMailbox/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/msexchangeonline/UserMailbox/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msexchangeonline/UserMailbox/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msexchangeonline/UserMailbox/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msexchangeonline/UserMailbox/ |
|
The device/msexchangeonline/UserMailbox schema and all instances as JSON. |
(The list will return 0 to 3 device/msexchangeonline/UserMailbox instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msexchangeonline/UserMailbox/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.0.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msexchangeonline/UserMailbox/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/msexchangeonline/UserMailbox",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msexchangeonline/UserMailbox/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/msexchangeonline/UserMailbox/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msexchangeonline/UserMailbox/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msexchangeonline/UserMailbox/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/msexchangeonline/UserMailbox/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msexchangeonline/UserMailbox/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msexchangeonline/UserMailbox/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msexchangeonline/UserMailbox/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msexchangeonline/UserMailbox/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msexchangeonline/UserMailbox/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msexchangeonline/UserMailbox/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msexchangeonline/UserMailbox",
"model_specific_actions": [
"list",
"get",
"update",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display 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/msexchangeonline/UserMailbox. | GET | /api/device/msexchangeonline/UserMailbox/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msexchangeonline/UserMailbox as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msexchangeonline/UserMailbox/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msexchangeonline/UserMailbox | 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/msexchangeonline/UserMailbox; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msexchangeonline/UserMailbox/[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/msexchangeonline/UserMailbox and the JSON format can be used to import instances of device/msexchangeonline/UserMailbox.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msexchangeonline/UserMailbox/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msexchangeonline/UserMailbox/[pkid]/ | hierarchy=[hierarchy] | The device/msexchangeonline/UserMailbox instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msexchangeonline/UserMailbox/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msexchangeonline/UserMailbox. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msexchangeonline/UserMailbox/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |