[Index]
Model ref.: device/exchange/MailboxFolder
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": { "FolderPath": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MapiFolderPath", "required": false, "name": "FolderPath", "title": "FolderPath", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "The 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" }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies the name of the new folder.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "Parent": { "__type_requested": "MailboxFolderIdParameter", "required": true, "description": "The Parent parameter specifies values of the mailbox identity and the parent folder under which the new folder is to be created. If the parent folder isn't specified, the cmdlet creates the folder in the root folder hierarchy of the specified mailbox. You can specify the values in this format: <Mailbox Identity>:<Parent>\nValid values for <Mailbox Identity> include:\nGUID\nADObjectID\nDistinguished name (DN)\nDomain\\username\nUser principal name (UPN)\nLegacyExchangeDN\nSMTP address\nAlias\nStore object ID of the parent folder\nValues for <Parent> can be both the store object ID and a path string such as \"\\Inbox\\Personal\".", "title": "Parent", "__type_mapping_type": "Unknown", "name": "Parent", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "HasSubfolders": { "__type_requested": "System.Boolean", "required": false, "name": "HasSubfolders", "title": "HasSubfolders", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "MailboxOwnerId": { "__type_requested": "System.String", "required": false, "name": "MailboxOwnerId", "title": "MailboxOwnerId", "__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" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DefaultFolderType": { "__type_requested": "System.String", "required": false, "name": "DefaultFolderType", "title": "DefaultFolderType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "FolderClass": { "__type_requested": "System.String", "required": false, "name": "FolderClass", "title": "FolderClass", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ParentFolder": { "__type_requested": "System.String", "required": false, "name": "ParentFolder", "title": "ParentFolder", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "FolderStoreObjectId": { "__type_requested": "System.String", "required": false, "name": "FolderStoreObjectId", "title": "FolderStoreObjectId", "__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" }, "ExtendedFolderFlags": { "__type_requested": "", "required": false, "name": "ExtendedFolderFlags", "title": "ExtendedFolderFlags", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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 mailbox and the folder that the command returns information about. If the folder isn't specified, the command returns information about folders in the root hierarchy of the specified mailbox. You can specify values in the following format: <Mailbox Identity>:<Parent>\nValid values for <Mailbox Identity> include:\nGUID\nADObjectID\nDistinguished name (DN)\nDomain\\username\nUser principal name (UPN)\nLegacyExchangeDN\nSMTP address\nAlias\nStore object ID of the parent folder\nValues for <Parent> can be both the store object ID and a path string such as \\Inbox\\Personal." }, "FolderSize": { "__type_requested": "System.Int64", "required": false, "name": "FolderSize", "title": "FolderSize", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchange/MailboxFolder/add/ |
|
The GUI Add form of device/exchange/MailboxFolder 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/exchange/MailboxFolder | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchange/MailboxFolder/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchange/MailboxFolder/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/MailboxFolder/[pkid1]", "/api/v0/device/exchange/MailboxFolder/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchange/MailboxFolder/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxFolder |
|
{"hrefs": ["/api/device/exchange/MailboxFolder/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxFolder |
|
{"hrefs": ["/api/device/exchange/MailboxFolder/[pkid1]", "/api/device/exchange/MailboxFolder/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/MailboxFolder; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchange/MailboxFolder/export/ |
|
{ "hrefs":["/api/device/exchange/MailboxFolder/[pkid1]", "/api/device/exchange/MailboxFolder/[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/exchange/MailboxFolder and the JSON format can be used to import instances of device/exchange/MailboxFolder.
GET http://[host-proxy]/api/device/exchange/MailboxFolder/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchange/MailboxFolder | POST | /api/device/exchange/MailboxFolder/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/exchange/MailboxFolder/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchange/MailboxFolder/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchange/MailboxFolder/ |
|
The device/exchange/MailboxFolder schema and all instances as JSON. |
(The list will return 0 to 3 device/exchange/MailboxFolder instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchange/MailboxFolder/?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/exchange/MailboxFolder/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchange/MailboxFolder/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/exchange/MailboxFolder", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchange/MailboxFolder/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/exchange/MailboxFolder/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchange/MailboxFolder/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchange/MailboxFolder/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchange/MailboxFolder/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchange/MailboxFolder/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchange/MailboxFolder/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchange/MailboxFolder", "model_specific_actions": [ "get", "list", "add", "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/exchange/MailboxFolder. | GET | /api/device/exchange/MailboxFolder/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchange/MailboxFolder as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchange/MailboxFolder/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchange/MailboxFolder/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchange/MailboxFolder | 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/exchange/MailboxFolder; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchange/MailboxFolder/[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/exchange/MailboxFolder and the JSON format can be used to import instances of device/exchange/MailboxFolder.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchange/MailboxFolder/[pkid] | hierarchy=[hierarchy] | The device/exchange/MailboxFolder instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchange/MailboxFolder/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchange/MailboxFolder. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchange/MailboxFolder/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |