Cora Knowledge Center

Support

POST /MessagesService.svc/GetData

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

NameTypeRequiredDescription
PageSizeintegeroptionalNumber of records returned on a page.
PageNumintegeroptionalNumber of the page to retrieve records for.
ContextMenuIdstringoptionalName of menu for the item.
IgnoreUserTimebooleanoptionalEngine time or user time.
SortDirection0,1optionalSort by desc or asc.
FilterExpressionobjectoptionalExpression by which to filter.
MessageInstanceViewItemTypeenumoptionalValues: 0, 1, 2
MessageInstanceViewTypeenumoptionalValues: 1, 2, 3, 4
SearchStringstring
Search for this value in these fields: Subject, Body, Sender.
SearchSubjectstring
Search for this value in the message subject.
SearchBodystring
Search for this value in the message body.
SearchFromstring
Search for this value in the message sender.
FromDatedate (JSON format)
Search for mailbox items starting from this date.
ToDatedate (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

NameTypeDescription
CurrentRowsintegerNumber of items returned.
ItemsarrayList of items returned. Each item contains properties as defined in the config file, for example {WorkflowInstance:1 ,[etc.]}.
TotalRowsintegerNumber of total items in the system.