Chat now with support
Chat with Support

Archive Manager 5.9.6 - RESTful API Service Guide

Common rules Advanced searches Alert service global setting Alert service policies Alert service queries Attachments Authentication (login) Configurations Contacts Delegations Exported searches Folders Groups Logins Login domains Mailboxes Mailstores Messages
.../v1/messages/schema.{format} .../v1/messages.{format} .../v1/messages/{messageId}.{format} .../v1/messages/{messageId}/html.{format} .../v1/messages/{messageId}/plaintext.{format} .../v1/messages/{messageId}/raw.{format} .../v1/messages/{messageId}/rtf.{format} .../v1/messages/{checksum}/bodyhtml .../v1/messages/{checksum}/eml .../v1/messages/{checksum}/sendmail.{format} .../v1/messages/{checksum}/web.{format} .../v1/messages/searchresults/schema.{format} .../v1/messages/rtfImage/{fileName} .../v1/messages/web/schema.{format} .../v1/messages/web.{format} .../v1/messages/{checksumOrId}/accesshistories.{format} .../v1/messages/{checksumOrId}/availabletags.{format} .../v1/messages/{checksumOrId}/comments.{format} .../v1/messages/{checksumOrId}/journalreports.{format} .../v1/messages/{checksumOrId}/tags.{format} .../v1/messages/{checksumOrId}/tags/{tagId}.{format}
Message comments Message folders Message tags Message types Organizational units Product Retention change logs Retention holds Retention message logs Retention policies Retention runs Retention run policies Retention schedule Retention settings Security roles Server Tags

PUT

Associates or disassociates a list of filtered messages to a list of tags by the message ID and tag ID. If a messageID has been associated with a tag ID, ignore it and continue.

Request body:

•
messageFilter
•
queryId: A Base64 encoded value in the Response Header “X-QueryId”. It can be used to re-attach to a search result table or reissue a search result.
•
includeIds: List of the message and instance IDs to include. Use “;” to separate the value pairs. Use “|” to separate the message ID and the instance ID. For example, “12”;”34|1”;”32|0”. Effective when the search ID is null or empty. Ignored when the search ID is specified.
•
excludeIds: List of the message and instance IDs to exclude. Use “;” to separate the value pairs. Use “|” to separate the message ID and the instance ID. For example, “12”;”34|1”;”32|0”. Effective when the search ID is specified. Ignored when the search ID is not specified.
•
tagIds: The tag ID list.
•
method: The operation methods including Link and Unlink.
•
tagParent: Indicates whether to add tags to the parent messages. The default value is False.

Result:

•
state: The execution result. Can be Fail, Success and PartialSuccess.
•
message: The error or warning message.

JSON request sample 1

{
"messageFilter": {
"queryId": "S0VZOkxPQ0FMOjI7YjQ0NGRlNTI0ZmFlZDljZDYyOTVmYzIzNDlkNzU0NWZ8MjAxNTA5MjUwNzI4MjBaXzNkNg==",
"excludeIds": [
76|1,
3
]
},
"method": "Link",
"tagIds": [
1,
2,
3,
4
],
"tagParent": "True"
}

JSON request sample 2

{
"messageFilter": {
"includeIds": [
5|1,
6|2,
7
]
},
"method": "UnLink",
"tagIds": [
1,
2,
3,
4
],
"tagParent": "True"
}

JSON response sample

{
"state": "PartialSuccess",
"message": "(Message 12, Tag 5) not linked."
}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating