API Reference for device/exchange/MessageClassification

Model ref.: device/exchange/MessageClassification

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "DisplayName": {
               "__type_requested": "String",
               "__type_mapping_type": "String",
               "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",
               "required": true,
               "readonly": false,
               "type": "string",
               "name": "DisplayName"
          },
          "OrganizationId": {
               "__type_requested": "System.String",
               "required": false,
               "name": "OrganizationId",
               "title": "OrganizationId",
               "__type_mapping_type": "String",
               "readonly": true,
               "type": "string"
          },
          "IgnoreDehydratedFlag": {
               "__type_requested": "SwitchParameter",
               "__type_mapping_type": "Boolean",
               "description": "This parameter is reserved for internal Microsoft use.",
               "title": "IgnoreDehydratedFlag",
               "required": false,
               "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",
               "__type_mapping_type": "String",
               "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",
               "required": false,
               "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",
               "__type_mapping_type": "String",
               "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",
               "required": true,
               "readonly": false,
               "type": "string",
               "name": "Name"
          },
          "ClassificationID": {
               "__type_requested": "Guid",
               "__type_mapping_type": "String",
               "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",
               "required": false,
               "readonly": false,
               "type": "string",
               "name": "ClassificationID"
          },
          "PermissionMenuVisible": {
               "__type_requested": "$true | $false",
               "__type_mapping_type": "Boolean",
               "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",
               "required": false,
               "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",
               "__type_mapping_type": "Unknown",
               "description": "The Organization parameter is reserved for internal Microsoft use.",
               "title": "Organization",
               "required": false,
               "readonly": true,
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
               "type": "string",
               "name": "Organization"
          },
          "ExchangeVersion": {
               "__type_requested": "System.String",
               "required": false,
               "name": "ExchangeVersion",
               "title": "ExchangeVersion",
               "__type_mapping_type": "String",
               "readonly": true,
               "type": "string"
          },
          "SenderDescription": {
               "__type_requested": "String",
               "__type_mapping_type": "String",
               "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",
               "required": true,
               "readonly": false,
               "type": "string",
               "name": "SenderDescription"
          },
          "DomainController": {
               "__type_requested": "Fqdn",
               "__type_mapping_type": "String",
               "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",
               "required": false,
               "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": "",
               "__type_mapping_type": "Unknown",
               "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",
               "required": true,
               "readonly": true,
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
               "type": "string",
               "name": "Locale"
          },
          "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"
          },
          "ObjectState": {
               "__type_requested": "System.String",
               "required": false,
               "name": "ObjectState",
               "title": "ObjectState",
               "__type_mapping_type": "String",
               "readonly": true,
               "type": "string"
          },
          "AdminDisplayName": {
               "__type_requested": "System.String",
               "required": false,
               "name": "AdminDisplayName",
               "title": "AdminDisplayName",
               "__type_mapping_type": "String",
               "readonly": true,
               "type": "string"
          },
          "DisplayPrecedence": {
               "__type_requested": "System.String",
               "__type_mapping_type": "String",
               "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",
               "required": false,
               "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"
          },
          "RetainClassificationEnabled": {
               "__type_requested": "$true | $false",
               "__type_mapping_type": "Boolean",
               "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",
               "required": false,
               "readonly": false,
               "type": "boolean",
               "name": "RetainClassificationEnabled"
          }
     },
     "schema_version": "15312"
}

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

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

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

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

 GET http://[host-proxy]/api/device/exchange/MessageClassification/?hierarchy=[hierarchy]

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

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

(The list will return 0 to 3 device/exchange/MessageClassification instances)

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "DisplayName",
          "direction": "asc",
          "current": "/api/device/exchange/MessageClassification/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
     },
     "operations": [
          "move"
     ],
     "meta": {
          "model_type": "device/exchange/MessageClassification",
          "summary_attrs": [
               {
                    "name": "DisplayName",
                    "title": "DisplayName"
               },
               {
                    "name": "Name",
                    "title": "Name"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": []
          },
          "model_specific_actions": [
               "get",
               "list",
               "add",
               "remove",
               "update",
               "bulk_update_form",
               "clone",
               "configuration_template",
               "export",
               "export_bulkload_template",
               "field_display_policy",
               "help",
               "move"
          ],
          "schema_version": "15312",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/device/exchange/MessageClassification/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/device/exchange/MessageClassification/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/device/exchange/MessageClassification/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
                         "support_async": false,
                         "title": "Bulk Modify"
                    }
               },
               {
                    "move": {
                         "method": "POST",
                         "class": "move",
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchange/MessageClassification",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/exchange/MessageClassification/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "export_bulkload_template": {
                         "method": "POST",
                         "class": "bulkload_template",
                         "href": "/api/device/exchange/MessageClassification/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/exchange/MessageClassification/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/exchange/MessageClassification/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/exchange/MessageClassification/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/exchange/MessageClassification/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/exchange/MessageClassification/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/exchange/MessageClassification.	GET	/api/device/exchange/MessageClassification/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchange/MessageClassification as HTML

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/exchange/MessageClassification/purge/	hierarchy=[hierarchy] format=json

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/exchange/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/exchange/MessageClassification/[pkid]	hierarchy=[hierarchy]

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

GET http://[host-proxy]/api/device/exchange/MessageClassification/?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/exchange/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/exchange/MessageClassification; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchange/MessageClassification/[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

The XLSX format can be used to bulk load instances of device/exchange/MessageClassification and the JSON format can be used to import instances of device/exchange/MessageClassification.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/exchange/MessageClassification/[pkid]	hierarchy=[hierarchy]	The device/exchange/MessageClassification instance with [pkid].

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

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

API Reference for device/exchange/MessageClassification

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

Help

Purge

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge