[Index]
Model ref.: device/exchangehybrid/DataClassification
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": { "AllLocalizedNames": { "__type_requested": "Deserialized.System.Collections.Generic.Dictionary`2[[System.Globalization.CultureInfo,", "required": false, "name": "AllLocalizedNames", "title": "AllLocalizedNames", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AllLocalizedDescriptions": { "__type_requested": "Deserialized.System.Collections.Generic.Dictionary`2[[System.Globalization.CultureInfo,", "required": false, "name": "AllLocalizedDescriptions", "title": "AllLocalizedDescriptions", "__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" }, "ClassificationType": { "__type_requested": "System.String", "required": false, "name": "ClassificationType", "title": "ClassificationType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Description": { "__type_requested": "String", "required": true, "description": "The Description parameter specifies a description for the data classification rule.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example:\nName\nLocalizedName\nIdentity GUID value" }, "RecommendedConfidence": { "__type_requested": "System.UInt32", "required": false, "name": "RecommendedConfidence", "title": "RecommendedConfidence", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Publisher": { "__type_requested": "System.String", "required": false, "name": "Publisher", "title": "Publisher", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies a name for the data classification rule. The value must be less than 256 characters.\nThe value of this parameter is used in the Policy Tip that's presented to users in Outlook Web App.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "ClassificationRuleCollection": { "__type_requested": "System.String", "required": false, "name": "ClassificationRuleCollection", "title": "ClassificationRuleCollection", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Fingerprints": { "__type_requested": "MultiValuedProperty", "required": true, "description": "The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see New-Fingerprint or the section.", "title": "Fingerprints", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "Fingerprints" }, "LocalizedName": { "__type_requested": "System.String", "required": false, "name": "LocalizedName", "title": "LocalizedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsEncrypted": { "__type_requested": "System.Boolean", "required": false, "name": "IsEncrypted", "title": "IsEncrypted", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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" }, "DefaultCulture": { "__type_requested": "System.Globalization.CultureInfo", "required": false, "name": "DefaultCulture", "title": "DefaultCulture", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ClassificationRuleCollectionIdentity": { "__type_requested": "ClassificationRuleCollectionIdParameter", "required": false, "description": "The ClassificationRuleCollectionIdentity parameter is reserved for future use.\nNew data classification rules that you create are automatically added to the classification rule collection named Fingerprint Classification Collection.", "title": "ClassificationRuleCollectionIdentity", "__type_mapping_type": "Unknown", "name": "ClassificationRuleCollectionIdentity", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "This parameter is available only in on-premises Exchange 2013.\nThe DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DomainController" }, "Locale": { "__type_requested": "CultureInfo", "required": false, "description": "The Locale parameter specifies the language that's associated with the data classification rule. Valid input for this parameter is a Microsoft .NET Framework CultureInfo class culture code value. For example, en for English or fr for French. If you don't specify a value for the Locale parameter, the default language of your Exchange organization is used when you create the data classification rule.\nYou can add additional language translations to the data classification rule by using the Set-DataClassification cmdlet.", "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" }, "MinEngineVersion": { "__type_requested": "System.String", "required": false, "name": "MinEngineVersion", "title": "MinEngineVersion", "__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" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/DataClassification/add/ |
|
The GUI Add form of device/exchangehybrid/DataClassification 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/DataClassification/ | 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/DataClassification/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/DataClassification/[pkid1]", "/api/device/exchangehybrid/DataClassification/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/DataClassification/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/DataClassification/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/DataClassification/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/DataClassification/[pkid1]", "/api/v0/device/exchangehybrid/DataClassification/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/DataClassification/?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/DataClassification |
|
{"hrefs": ["/api/device/exchangehybrid/DataClassification/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/DataClassification |
|
{"hrefs": ["/api/device/exchangehybrid/DataClassification/[pkid1]", "/api/device/exchangehybrid/DataClassification/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/DataClassification; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/DataClassification/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/DataClassification/[pkid1]", "/api/device/exchangehybrid/DataClassification/[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/DataClassification and the JSON format can be used to import instances of device/exchangehybrid/DataClassification.
GET http://[host-proxy]/api/device/exchangehybrid/DataClassification/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/DataClassification | POST | /api/device/exchangehybrid/DataClassification/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/DataClassification/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/DataClassification/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/DataClassification/ |
|
The device/exchangehybrid/DataClassification schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/DataClassification instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/DataClassification/?skip=0&limit=3&order_by=Description&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/DataClassification/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/DataClassification/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/DataClassification/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/DataClassification", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/DataClassification/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/DataClassification/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/DataClassification/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/DataClassification/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/DataClassification/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/DataClassification/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/DataClassification/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/DataClassification", "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": "Description", "title": "Description" }, { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangehybrid/DataClassification. | GET | /api/device/exchangehybrid/DataClassification/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/DataClassification as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/DataClassification/[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/DataClassification/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/DataClassification/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/DataClassification/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/DataClassification | 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/DataClassification; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/DataClassification/[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/DataClassification and the JSON format can be used to import instances of device/exchangehybrid/DataClassification.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/DataClassification/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/DataClassification instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/DataClassification/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/DataClassification. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/DataClassification/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |