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

.../v1/attachments.{format}

Supported HTTP method

GET

Supported HTTP method

.../v1/attachments.{format}

GET

GET

Retrieves a list of attachments. If no query parameters are specified, the current login ID is applied.

Parameters:

•
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.
•
searchId: A GUID instance. Can be null when a query ID is specified.
•
query
•
sort
•
offset
•
limit
•
fields
•
forceRefresh: Force-refresh search results without cache. Default value is False.

Query parameters:

•
searchAllEmails
•
mailboxType
•
mailboxIds
•
folderId
•
includeSubFolders
•
True: Include sub folders.
•
False: Not include sub folders.
•
ftsQuery
•
to: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
from: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
toOrFrom: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
dateMin
•
dateMax
•
dateProcessedMin
•
dateProcessedMax
•
dateModifiedMin
•
dateModifiedMax
•
attachmentName
•
attachmentType: Separate multiple types by semicolon, for example, txt;pdf;docx. Use the symbol "!" to exclude a file type, for example, !txt;!pdf, this will search for messages that do not have TXT or PDF attachment(s).
•
attachmentContentType
•
attachmentSizeMin
•
attachmentSizeMax
•
attachmentVisible
•
attachmentAttachMethod: For example, attachmentType:Ole|EmbeddedMsg.
•
None
•
ByBalue
•
EmbeddedMsg
•
Ole
•
tagName: Separate multiple tags by semicolon, for example, tagName:Food;Fruit. Use the symbol "!" to exclude a tag, for example, tagName:!Food;!Fruit.
•
federated
•
instanceIds
•
loginId
•
impersonate
•
messageType
•
messageClass

Sortable fields:

•
fileName
•
fileType
•
size
•
contentDisposition
•
contentType
•
contentId
•
attachMethod
•
charset
•
rtfPosition
•
visible
* 
TIP: For example, to search all attachments,
.../v1/attachments.json?query=searchallemails:true

To search attachments by query ID,
...v1/attachments.json?=S0VZOkxPQ0FMOjE7YTYwYjkzM2M1NmE0MGQ0OGIwNGQzY2Y5MmUxMzA2OTF8MjAxNTA4MTQwNjAzMzFaXzE3ZQ==

To search attachments by Full Text Search,
.../v1/attachments.json?query=ftsQuery:Software,ftsScope:All

JSON response sample

{
"items": [
{
"rowId": 0,
"id": 4,
"checkSum": "6790c062-7e21-0e4f-1219-7a08a01b2546",
"contentType": "application/octet-stream",
"fileName": "Dell.AM.BusinessLayer.pdb",
"fileType": "pdb",
"rtfPosition": 0,
"size": 2541056,
"attachMethod": 1,
"visible": true,
"canOpen": false,
"openAsAttachment": false
},
{
"rowId": 0,
"id": 2,
"checkSum": "038cd38b-e9b9-3066-8445-e58d6bc5bb66",
"contentType": "text/plain",
"fileName": "license-Ongoing.asc",
"fileType": "asc",
"rtfPosition": 0,
"size": 562,
"attachMethod": 1,
"visible": true,
"canOpen": false,
"openAsAttachment": false
},
{
"rowId": 0,
"id": 6,
"checkSum": "2829fd11-4893-d139-c02f-0aaacf8a27f0",
"contentType": "application/octet-stream",
"fileName": "XPSEP XP and Server 2003 32 bit.msi",
"fileType": "msi",
"rtfPosition": 0,
"size": 7842816,
"attachMethod": 1,
"visible": true,
"canOpen": false,
"openAsAttachment": false
}
]
}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating