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

Supported HTTP method

.../v1/exportedsearches

GET

GET

Exports a specified search to a *.amexp file.

Parameters:

•
searchId: A GUID instance. Can be null when a query ID is specified.
•
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. Can be null when a search ID is specified.
•
fileName: Uses export{searchId}.amexp by default when it is null.

Exported file sample

Filename: Exportbb5a16af-a727-4994-938f-a1bc4cba8327.amexp

Content:

<?xml version= "1.0" encoding="utf-8"?>

<AfterMailSearchStub xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SearchIdentifier>bb5a16af-a727-4994-938f-a1bc4cba8327</SearchIdentifier>

<SearchKey>S0VZOkxPQ0FMOjI7OTExMzljMzg1YTQ1ZTEyNmY2YWZmMzk4MTA3ZjlhMDJ8MjAxNTA5MzAwMzIyMjhaX2JjZg==</SearchKey>

<Server>archivemanager</Server>

<Port>80</Port>

<Username>Administrator</Username>

<Domain>DC2K8</Domain>

<AuthenticationMode>Forms</AuthenticationMode>

</AfterMailSearchStub>

Folders

•
.../v1/folders/schema.{format}
•
.../v1/folders.{format}
•
.../v1/folders/{folderId}.{format}
•
.../v1/folders/{folderId}/messages.{format}
•
.../v1/folders/{folderId}/messages/count.{format}
•
.../v1/folders/{folderId}/messages/{messageId}.{format}
•
.../v1/folders/{parentFolderId}/subfolders.{format}
•
.../v1/folders/{parentFolderId}/subfolders/count.{format}
•
.../v1/folders/{parentFolderId}/subfolders/{subfolderId}.{format}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating