Returns actions items that were fetched by the user back to the queue.
Method
POST
URL
https://localhost/Flowtime/_vti_bin/Flowtime/MessagesService.svc/ReturnMessage
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
messageInstanceId | integer | required | ID of message |
PageSize | integer | optional | Number of records returned on a page. |
PageNum | integer | optional | Number of the page to retrieve records for. |
Example Request
$.ajax({
type: 'POST',
url: "https://server:port/Flowtime/_vti_bin/Flowtime/MessagesService.svc/ReturnMessage",
contentType: "application/json; charset=utf-8",
dataType: "json",
data: JSON.stringify({ 'messageInstanceId': messageId }),
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 |
|---|---|---|
Id | integer | The message ID, relevant when updating a collection of action items. |
Cancelled | boolean | 0 = cancelled, 1 = not cancelled |
CancelReason | string | The reason the procedure was cancelled. |
Example Response
CommandResult:
{
Id:[integer],
Cancelled:[bool],
CancelReason:[string]
}
