Returns the specified user's mailbox, including open messages, closed messages, and tasks.
Method
POST
URL
https://localhost/Flowtime/_vti_bin/Flowtime/MessagesService.svc/GetData
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
PageSize | integer | optional | Number of records returned on a page. |
PageNum | integer | optional | Number of the page to retrieve records for. |
ContextMenuId | string | optional | Name of menu for the item. |
IgnoreUserTime | boolean | optional | Engine time or user time. |
SortDirection | 0,1 | optional | Sort by desc or asc. |
FilterExpression | object | optional | Expression by which to filter. |
MessageInstanceViewItemType | enum | optional | Values: 0, 1, 2 |
MessageInstanceViewType | enum | optional | Values: 1, 2, 3, 4 |
SearchString | string | Search for this value in these fields: Subject, Body, Sender. | |
SearchSubject | string | Search for this value in the message subject. | |
SearchBody | string | Search for this value in the message body. | |
SearchFrom | string | Search for this value in the message sender. | |
FromDate | date (JSON format) | Search for mailbox items starting from this date. | |
ToDate | date (JSON format) | Search for mailbox items ending on this date. |
Example Request
var request = {
{
"PageSize":15,
"PageNum":1,
"ContextMenuId":"default",
"IgnoreUserTime":false,
"SortDirection":1,
"FilterExpression":{},
"MessageInstanceViewItemType":0,
"MessageInstanceViewType":2,
"SearchString":"",
"SearchSubject":"",
"SearchBody":"",
"SearchFrom":"",
"FromDate":"/Date(-2206317600000-0000)/",
"ToDate":"/Date(253373522399000-0000)/"
}
};
$.ajax({
type: "POST",
url: "http://server:port/_vti_bin/Flowtime/ MessagesService.svc/GetData",
data: JSON.stringify(request),
dataType: "json",
contentType: "application/json; charset=utf-8",
headers: {
"uiculture": "en-GB",
"culture": "en-GB",
"X-SqXsrfToken": xsrf
},
success: function (data) {
alert(data)
},
error: function (error) {
console.log(error);
}
});
Response Parameters
| Name | Type | Description |
|---|---|---|
CurrentRows | integer | Number of items returned. |
Items | array | List of items returned. Each item contains properties as defined in the config file, for example {WorkflowInstance:1 ,[etc.]}. |
TotalRows | integer | Number of total items in the system. |
