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

JSON request sample

{
"savedSearchID": 18,
"name": "list_advancedSearch_03",
"query": {
"searchAllEmails": false,
"mailboxType": "Lync",
"mailboxIds": [
12,
3,
5
],
"folderId": 12,
"includeSubFolders": false,
"fullTextSearchCriteria": {
"query": "test query",
"scope": "Subject|Body"
},
"to": "justin@test.com",
"from": "test@test.com",
"toOrFrom": "test01.test.com;*aha*",
"dateMin": "2015-08-07T02:43:52Z",
"dateMax": "2015-09-07T02:43:52Z",
"dateProcessedMin": "2015-08-07T02:43:52Z",
"dateProcessedMax": "2015-09-07T02:43:52Z",
"dateModifiedMin": "2015-08-07T02:43:52Z",
"dateModifiedMax": "2015-09-07T02:43:52Z",
"hasAttachment": true,
"attachmentName": "attach",
"attachmentType": "PDF",
"attachmentContentType": "json",
"attachmentSizeMin": 0,
"attachmentSizeMax": 150,
"attachmentVisible": true,
"attachmentAttachMethod": "ByValue",
"attachmentCheckSum": "c9c14469-509b-49fc-91d6-3a51bd458157",
"tagName": "tag",
"federated": false,
"instanceIds": [
12,
3,
5
],
"loginId": 1,
"impersonate": "test"
},
"loginID": 1,
"binaryChecksum": 154990865
}

JSON response sample

{
"savedSearchID": 18,
"name": "list_advancedSearch_03",
"query": {
"searchAllEmails": false,
"mailboxType": "Lync",
"mailboxIds": [
12,
3,
5
],
"folderId": 12,
"includeSubFolders": false,
"fullTextSearchCriteria": {
"query": "test query",
"scope": "Subject|Body"
},
"to": "justin@test.com",
"from": "test@test.com",
"toOrFrom": "test01.test.com;*aha*",
"dateMin": "2015-08-07T02:43:52Z",
"dateMax": "2015-09-07T02:43:52Z",
"dateProcessedMin": "2015-08-07T02:43:52Z",
"dateProcessedMax": "2015-09-07T02:43:52Z",
"dateModifiedMin": "2015-08-07T02:43:52Z",
"dateModifiedMax": "2015-09-07T02:43:52Z",
"hasAttachment": true,
"attachmentName": "attach",
"attachmentType": "PDF",
"attachmentContentType": "json",
"attachmentSizeMin": 0,
"attachmentSizeMax": 150,
"attachmentVisible": true,
"attachmentAttachMethod": "ByValue",
"attachmentCheckSum": "c9c14469-509b-49fc-91d6-3a51bd458157",
"tagName": "tag",
"federated": false,
"instanceIds": [
12,
3,
5
],
"loginId": 1,
"impersonate": "test"
},
"loginID": 1,
"binaryChecksum": 154990865
}

PUT

Updates an advanced search by the search ID. It will return the advanced search updated to database.

JSON request sample

{
"savedSearchID": 18,
"name": "list_advancedSearch_03",
"query": {
"searchAllEmails": false,
"mailboxType": "Lync",
"mailboxIds": [
12,
3,
5
],
"folderId": 12,
"includeSubFolders": false,
"fullTextSearchCriteria": {
"query": "test query",
"scope": "Subject|Body"
},
"to": "justin@test.com",
"from": "test@test.com",
"toOrFrom": "test01.test.com;*aha*",
"dateMin": "2015-08-07T02:43:52Z",
"dateMax": "2015-09-07T02:43:52Z",
"dateProcessedMin": "2015-08-07T02:43:52Z",
"dateProcessedMax": "2015-09-07T02:43:52Z",
"dateModifiedMin": "2015-08-07T02:43:52Z",
"dateModifiedMax": "2015-09-07T02:43:52Z",
"hasAttachment": true,
"attachmentName": "attach",
"attachmentType": "PDF",
"attachmentContentType": "json",
"attachmentSizeMin": 0,
"attachmentSizeMax": 150,
"attachmentVisible": true,
"attachmentAttachMethod": "ByValue",
"attachmentCheckSum": "c9c14469-509b-49fc-91d6-3a51bd458157",
"tagName": "tag",
"federated": false,
"instanceIds": [
12,
3,
5
],
"loginId": 1,
"impersonate": "test"
},
"loginID": 1,
"binaryChecksum": 154990865
}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating