[Index]
Model ref.: device/exchangehybrid/MessageClassification
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": { "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" }, "Version": { "__type_requested": "System.Int32", "required": false, "name": "Version", "title": "Version", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "RecipientDescription": { "__type_requested": "String", "required": false, "description": "The RecipientDescription parameter specifies the purpose of the message classification to the recipient. The value of this parameter is shown to Outlook users when they receive a message that has this message classification. Enclose the value in quotation marks (\"), for example, \"This is the recipient description that explains how to treat the message that has been classified\". The RecipientDescription parameter can contain a maximum of 1,024 characters.\nIf you don't enter a value for this parameter, the description that you enter for the SenderDescription parameter is used.", "title": "RecipientDescription", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "RecipientDescription" }, "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" }, "IsDefault": { "__type_requested": "System.Boolean", "required": false, "name": "IsDefault", "title": "IsDefault", "__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 name of the message classification instance that you want to view. When you specify a name that includes spaces, you must enclose the name in quotation marks (\"), for example, \"Administrative Name\"." }, "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": "The Name parameter specifies the administrative name for the message classification instance. The name is used to administer the message classification instance. When you specify a name that includes spaces, you must enclose the name in quotation marks (\"), for example, \"Adminstrative Name\". The Name parameter can contain a maximum of 256 characters.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "ClassificationID": { "__type_requested": "Guid", "required": false, "description": "The ClassificationID parameter specifies a classification ID of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same enterprise.", "title": "ClassificationID", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ClassificationID" }, "PermissionMenuVisible": { "__type_requested": "$true | $false", "required": false, "description": "The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message.\nIf you set the PermissionMenuVisible parameter to $false, users won't be able to assign this message classification to the messages they are composing. However, messages received with this message classification still display the classification information.\nThe default value is $true.", "title": "PermissionMenuVisible", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "PermissionMenuVisible" }, "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" }, "SenderDescription": { "__type_requested": "String", "required": true, "description": "The SenderDescription parameter specifies the purpose of the message classification to the sender. The value of this parameter is used by Outlook users to select the appropriate message classification before they send a message. Enclose the value in quotation marks (\"), for example, \"This is the sender description that explains when to use this message classification\". The SenderDescription parameter can contain a maximum of 1,024 characters.", "title": "SenderDescription", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "SenderDescription" }, "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.\nThe DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.", "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" }, "Locale": { "__type_requested": "", "required": true, "description": "The Locale parameter specifies a locale-specific version of the message classification. You must also pass the Identity parameter of the default existing message classification when you create a new locale-specific version.\nValid input for the Locale parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (http://go.microsoft.com/fwlink/p/?linkId=184859).", "title": "Locale", "__type_mapping_type": "Unknown", "name": "Locale", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IsValid": { "__type_requested": "System.Boolean", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "SharedSecurityDescriptor": { "__type_requested": "System.String", "required": false, "name": "SharedSecurityDescriptor", "title": "SharedSecurityDescriptor", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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" }, "DisplayName": { "__type_requested": "String", "required": true, "description": "The DisplayName parameter specifies the display name for the message classification instance. The display name is used by Outlook users to select the appropriate message classification before they send a message.\nThe message classification XML file must be present on the sender's computer for the display name to be displayed.\nIf the UserDisplayEnabled parameter is set to $true, the display name is displayed for the recipient, even if no message classification XML file is installed.\nWhen you specify a name that includes spaces, you must enclose the name in quotation marks (\"), for example, \"Display Name\". The DisplayName parameter can contain a maximum of 64 characters.", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayName" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DisplayPrecedence": { "__type_requested": "System.String", "required": false, "description": "The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that may be applied to a specified message. Although Outlook only lets a user specify a single classification per message, transport rules may apply other classifications to a message. The classification with the highest precedence is shown first, and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter.\nValid input for the DisplayPrecedence parameter is Highest, Higher, High, MediumHigh, Medium, MediumLow, Low, Lower, and Lowest.\nThe default value is Medium.", "title": "DisplayPrecedence", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayPrecedence" }, "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" }, "RetainClassificationEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to.\nThe default value is $true.", "title": "RetainClassificationEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RetainClassificationEnabled" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/MessageClassification/add/ |
|
The GUI Add form of device/exchangehybrid/MessageClassification 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/MessageClassification/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangehybrid/MessageClassification/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/MessageClassification/[pkid1]", "/api/device/exchangehybrid/MessageClassification/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/MessageClassification/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/MessageClassification/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/MessageClassification/[pkid1]", "/api/v0/device/exchangehybrid/MessageClassification/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/MessageClassification |
|
{"hrefs": ["/api/device/exchangehybrid/MessageClassification/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/MessageClassification |
|
{"hrefs": ["/api/device/exchangehybrid/MessageClassification/[pkid1]", "/api/device/exchangehybrid/MessageClassification/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/MessageClassification; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/MessageClassification/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/MessageClassification/[pkid1]", "/api/device/exchangehybrid/MessageClassification/[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/MessageClassification and the JSON format can be used to import instances of device/exchangehybrid/MessageClassification.
GET http://[host-proxy]/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/MessageClassification | POST | /api/device/exchangehybrid/MessageClassification/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/exchangehybrid/MessageClassification/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/MessageClassification/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/MessageClassification/ |
|
The device/exchangehybrid/MessageClassification schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/MessageClassification instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/MessageClassification/?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": "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/MessageClassification/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/MessageClassification/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/MessageClassification", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/MessageClassification/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/MessageClassification/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/MessageClassification/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/MessageClassification/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/MessageClassification/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/MessageClassification/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/MessageClassification", "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": "DisplayName", "title": "DisplayName" }, { "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/MessageClassification. | GET | /api/device/exchangehybrid/MessageClassification/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/MessageClassification as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/MessageClassification/[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/MessageClassification/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/MessageClassification/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/MessageClassification/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/MessageClassification | 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/MessageClassification; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/MessageClassification/[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/exchangehybrid/MessageClassification and the JSON format can be used to import instances of device/exchangehybrid/MessageClassification.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/MessageClassification/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/MessageClassification instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/MessageClassification/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/MessageClassification. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/MessageClassification/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |