Chat now with support
Chat with Support

Archive Manager 5.9.5 - 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

Common rules

•
Archive Manager data objects are organized into collections.
•
Some collections have sub-collections.
•
All data objects and data object collections support four HTTP actions:
•
GET – Read.
•
POST – Create.
•
PUT – Update.
•
DELETE – Delete.
•
If the action is not listed in the Supported HTTP method it is currently Not Supported it will return a Not Supported error message.
•
All data objects and data object collections support both JSON and XML format.
•
Default format is JSON.
•
Format can be explicitly specified by adding “.xml” or “.json” to the requested object.
•
When submitting data via POST or PUT, if the data is in XML format, POST must be directed to the “.xml” endpoint.
•
POST - http://<archivemanager>/API/v1/logins.xml
•
PUT - http://<archivemanager>/API/v1/logins/15.xml
•
Collections will never exceed two levels.
•
OK – http://<archivemanager>/API/v1/logins/1/mailboxes
•
BAD – http://<archivemanager>/API/v1/logins/1/mailboxes/2/messages
•
For access to the messages of the mailbox, use the mailboxes collection
•
OK – http://<archivemanager>/API/v1/mailboxes/2/messages
•
Some collections can be counted. For example,
•
GET - http://<archivemanager>/API/v1/logins/count
•
GET - http://<archivemanager>/API/v1/logins/1/mailboxes/count
•
Collections, unless otherwise noted, support paging and sorting with these parameters:
•
limit: specifies the maximum number of entries to display on a single page. If not specified, the setting WWW Page Size (default value: 20) in Configuration Console will be applied.To display all the entries on a single page, set limit to 0.
•
offset: specifies the first entry to retrieve from a collection.
•
lastId: contains the ID of the last entry in the previous returned result. If specified, entries that have IDs greater than the lastId value will be returned.
•
top: specifies the maximum number of entries to retrieve. Effective when the lastId parameter is not specified.
•
sort: specifies the field by which the entries will be sorted. Use minus for descending order.
Examples:
•
GET - http://<archivemanager>/API/v1/logins?limit=10&offset=5
•
GET - http://<archivemanager>/API/v1/logins?limit=10&lastId=5
•
GET - http://<archivemanager>/API/v1/logins?top=10
•
GET - http://<archivemanager>/API/v1/logins?sort=id
•
GET - http://<archivemanager>/API/v1/logins?sort=-id
•
Data objects can be filtered if the API supports for the parameter fields. Use commas to separate multiple field properties.
•
Some collections support searching. Use an asterisk to use wildcards.
•
GET - http://<archivemanager>/API/v1/logins?query=loginName:admin*
•
When creating a new mailbox, if no OwnerLoginId is provided, the currently logged in user's LoginId is used. If an OwnerLoginId is provided, the newly-created mailbox is owned by that user. If the mailbox is created using a login's Mailboxes sub-collection, access to the mailbox is delegated to the login specified.
•
On remote servers HTTP Application ID header value is required.
•
X-ApplicationId: ApiTestApplication
•
This header is only required during the initial authentication, once an Authentication Cookie has been established the X-ApplicationId header is no longer required.
•
Response headers:
•
X-Result-TotalRows: Returns the number of the collections retrieved. The value will not be affected when the pagination parameter top is specified.
•
X-QueryId: Returns the current query ID for you to perform the same query with it if needed.
•
Link relations in the response header:
•
rel=“self”: Specifies the URL that generated the current response.
•
rel=”base”: Specifies the URL which calls the API.
•
rel=”next”: Navigates to the subsequent page of results when the parameter lastId is specified.
•
The Web Service supports Forms Authentication and Windows Authentication.
•
If IIS is configured for Forms Authentication the website will respond with a “WWW-Authenticate” challenge.
•
The correct response to this challenge is a header of “Authorization: Basic” a space and a base64 encoded colon separated key-value pair as described in RFC 2617.
•
After authentication a cookie is returned that can be used for future requests, you no longer need to provide the Authorization header if the cookie is valid.
•
The cookie is valid for 48 hours and renews after each request, use the updated cookie from each response. Can be set within Web.Config “AuthenticationTimeoutMinutes”.
•
API access can be over HTTP or HTTPS, using the URL prefix: http://<archivemanager>/API or https://<archivemanager>/API.
The <archivemanager> specifies the domain name or IP address of the server where the REST service endpoint is hosted.
The reference documentation for each API call shows the REST resource, method, and parameters that must be appended to the base URL to form a request. The following is an example of a well-formed REST URL:
http://<archivemanager>/API/v1/logins.

Advanced searches

•
.../v1/searchQueries/schema.{format}
•
.../v1/searchQueries.{format}
•
.../v1/searchQueries/{advancedSearchId}.{format}​​​

.../v1/searchQueries/schema.{format}

Supported HTTP method

GET

Supported HTTP method

.../v1/searchQueries/schema.{format}

GET

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating