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

GET

Retrieves a list of delegation status by the provided query conditions. The current user can view the delegation status of all users with the permission View Delegation, otherwise, only the delegation status of the current user will be shown. An unauthorized exception will be thrown when the current user without the permission View Delegation attempts to view delegation status of the others.

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

Query parameters:

•
source
•
dateMin
•
dateMax
•
loginId
•
mailboxId
•
delegationAgreementId
•
enabled
•
private
•
status: Can be Pending, Success, PartialSuccess, Fail, and Abandon.

JSON response sample

[
{
"date": "2018-11-15T14:15:50Z",
"source": "c-ip:'10.154.12.86'|cs-username:'Test Login'",
"loginID": 1,
"mailBoxID": 2,
"delegationAgreementID": 1,
"enabled": true,
"loginName": "Test Login",
"mailBoxName": "Test MailBox",
"status": "Success"
},
{
"date": "2018-11-14T14:15:50Z",
"source": "c-ip:'10.154.12.87'|cs-username:'Test Login1'",
"loginID": 1,
"mailBoxID": 3,
"delegationAgreementID": 1,
"enabled": true,
"loginName": "Test Login1",
"mailBoxName": "Test MailBox1",
"status": "Fail"
},
{
"date": "2018-11-13T14:15:50Z",
"source": "c-ip:'10.154.12.88'|cs-username:'Test Login2'",
"loginID": 2,
"mailBoxID": 3,
"delegationAgreementID": 2,
"enabled": false,
"loginName": "Test Login2",
"mailBoxName": "Test MailBox2",
"status": "Pending"
}
]

.../v1/delegationlogs/logins/{loginId}/mailboxes/{mailboxId}.{format}

Supported HTTP method

GET

Supported HTTP method

.../v1/delegationlogs/logins/{loginId}/mailboxes/{mailboxId}.{format}

GET

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating