[Index]
Model ref.: device/exchangehybrid/RetentionPolicyTag
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": { "IsDefaultAutoGroupPolicyTag": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "IsDefaultAutoGroupPolicyTag", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsDefaultAutoGroupPolicyTag" }, "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" }, "ManagedFolderToUpgrade": { "__type_requested": "ELCFolderIdParameter", "required": false, "description": "This parameter is available only in on-premises Exchange 2013.\nThe ManagedFolderToUpgrade parameter specifies the name of a managed folder to use as a template for a retention tag.", "title": "ManagedFolderToUpgrade", "__type_mapping_type": "Unknown", "name": "ManagedFolderToUpgrade", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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" }, "IsDefaultModeratedRecipientsPolicyTag": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "IsDefaultModeratedRecipientsPolicyTag", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsDefaultModeratedRecipientsPolicyTag" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "LocalizedComment": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Microsoft Office Outlook Web App display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:\"This is a localized comment in U.S. English\".", "title": "LocalizedComment", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "LocalizedComment" }, "JournalingEnabled": { "__type_requested": "$true | $false", "required": false, "description": "This parameter isn't available in this release.", "title": "JournalingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "JournalingEnabled" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Description": { "__type_requested": "System.String", "required": false, "name": "Description", "title": "Description", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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" }, "Type": { "__type_requested": "System.String", "required": false, "description": "The Type parameter specifies the type of retention tag being created. Valid values include:\nCalendar\nContacts\nDeletedItems\nDrafts\nInbox\nJunkEmail\nJournal\nNotes\nOutbox\nSentItems\nTasks\nAll\nRecoverableItems\nRssSubscriptions\nSyncIssues\nConversationHistory\nPersonal\nTo create a default policy tag (DPT), specify type All. For tags of type RecoverableItems, the only valid retention action is MoveToArchive.", "title": "Type", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Type" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RetentionId": { "__type_requested": "Guid", "required": false, "description": "The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments.", "title": "RetentionId", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "RetentionId" }, "MessageFormatForJournaling": { "__type_requested": "System.String", "required": false, "description": "This parameter isn't available in this release.", "title": "MessageFormatForJournaling", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MessageFormatForJournaling" }, "MustDisplayCommentEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true.", "title": "MustDisplayCommentEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "MustDisplayCommentEnabled" }, "RetentionAction": { "__type_requested": "System.String", "required": false, "description": "The RetentionAction parameter specifies one of the following actions:\nMarkAsPastRetentionLimit If you specify this action for a retention tag, messages that have the tag applied are marked as past the retention limit.\nMoveToFolder This action isn't available for retention tags.\nMoveToDeletedItems This action isn't available for retention tags.\nDeleteAndAllowRecovery This action deletes a message and allows recovery from the Recoverable Items folder.\nPermanentlyDelete This action permanently deletes a message. A message that has been permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox.\nMoveToArchive This action moves a message to the user's archive mailbox. You can use this action for retention tags of type All, Personal, and RecoverableItems.\nIf this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned.", "title": "RetentionAction", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "RetentionAction" }, "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 tag." }, "MoveToDestinationFolder": { "__type_requested": "", "required": false, "name": "MoveToDestinationFolder", "title": "MoveToDestinationFolder", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "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 name of the tag.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "AgeLimitForRetention": { "__type_requested": "System.String", "required": false, "description": "The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned.", "title": "AgeLimitForRetention", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AgeLimitForRetention" }, "MessageClassDisplayName": { "__type_requested": "System.String", "required": false, "name": "MessageClassDisplayName", "title": "MessageClassDisplayName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "SystemTag": { "__type_requested": "$true | $false", "required": false, "description": "The SystemTag parameter specifies that the tag is created for internal Exchange functionality.", "title": "SystemTag", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "SystemTag" }, "RetentionEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled, and no retention action is taken on messages that have the tag applied.\nMessages with a disabled tag are still considered tagged, so any default policy tags in the user's retention policy aren't applied to such messages.\nWhen you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as DISABLED_<Original Name>.", "title": "RetentionEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RetentionEnabled" }, "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" }, "LegacyManagedFolder": { "__type_requested": "ELCFolderIdParameter", "required": false, "description": "The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies.", "title": "LegacyManagedFolder", "__type_mapping_type": "Unknown", "name": "LegacyManagedFolder", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "TriggerForRetention": { "__type_requested": "System.String", "required": false, "name": "TriggerForRetention", "title": "TriggerForRetention", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MessageClass": { "__type_requested": "String", "required": false, "description": "The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *.\nWith the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported, and they apply to all message types.\nTo create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All.\nA DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*).", "title": "MessageClass", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MessageClass" }, "Comment": { "__type_requested": "String", "required": false, "description": "The Comment parameter specifies a comment for the tag.", "title": "Comment", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Comment" }, "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" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "LocalizedRetentionPolicyTagName": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook Web App display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:\"Business Critical\".", "title": "LocalizedRetentionPolicyTagName", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "LocalizedRetentionPolicyTagName" }, "AddressForJournaling": { "__type_requested": "", "required": false, "description": "This parameter isn't available in this release.", "title": "AddressForJournaling", "__type_mapping_type": "Unknown", "name": "AddressForJournaling", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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" }, "LabelForJournaling": { "__type_requested": "String", "required": false, "description": "This parameter isn't available in this release.", "title": "LabelForJournaling", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "LabelForJournaling" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__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" }, "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" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/RetentionPolicyTag/add/ |
|
The GUI Add form of device/exchangehybrid/RetentionPolicyTag 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/RetentionPolicyTag/ | 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/RetentionPolicyTag/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/RetentionPolicyTag/[pkid1]", "/api/device/exchangehybrid/RetentionPolicyTag/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/RetentionPolicyTag/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/RetentionPolicyTag/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/RetentionPolicyTag/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/RetentionPolicyTag/[pkid1]", "/api/v0/device/exchangehybrid/RetentionPolicyTag/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/RetentionPolicyTag/?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/RetentionPolicyTag |
|
{"hrefs": ["/api/device/exchangehybrid/RetentionPolicyTag/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/RetentionPolicyTag |
|
{"hrefs": ["/api/device/exchangehybrid/RetentionPolicyTag/[pkid1]", "/api/device/exchangehybrid/RetentionPolicyTag/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/RetentionPolicyTag; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/RetentionPolicyTag/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/RetentionPolicyTag/[pkid1]", "/api/device/exchangehybrid/RetentionPolicyTag/[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/RetentionPolicyTag and the JSON format can be used to import instances of device/exchangehybrid/RetentionPolicyTag.
GET http://[host-proxy]/api/device/exchangehybrid/RetentionPolicyTag/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/RetentionPolicyTag | POST | /api/device/exchangehybrid/RetentionPolicyTag/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/RetentionPolicyTag/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/RetentionPolicyTag/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/RetentionPolicyTag/ |
|
The device/exchangehybrid/RetentionPolicyTag schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/RetentionPolicyTag instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/RetentionPolicyTag/?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/exchangehybrid/RetentionPolicyTag/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/RetentionPolicyTag/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/RetentionPolicyTag/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/RetentionPolicyTag", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/RetentionPolicyTag/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/RetentionPolicyTag/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/RetentionPolicyTag/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/RetentionPolicyTag/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/RetentionPolicyTag/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/RetentionPolicyTag/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/RetentionPolicyTag/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/RetentionPolicyTag", "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": "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/RetentionPolicyTag. | GET | /api/device/exchangehybrid/RetentionPolicyTag/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/RetentionPolicyTag as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/RetentionPolicyTag/[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/RetentionPolicyTag/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/RetentionPolicyTag/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/RetentionPolicyTag/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/RetentionPolicyTag | 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/RetentionPolicyTag; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/RetentionPolicyTag/[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/RetentionPolicyTag and the JSON format can be used to import instances of device/exchangehybrid/RetentionPolicyTag.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/RetentionPolicyTag/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/RetentionPolicyTag instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/RetentionPolicyTag/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/RetentionPolicyTag. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/RetentionPolicyTag/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |