Fetch a broadcast task to the current user.
Method
POST
URL
https://localhost/Flowtime/_vti_bin/Flowtime/MessagesService.svc/FetchMessage
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
messageInstanceId | integer | required | Message ID for the user you want to fetch the task for. |
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/FetchMessage", 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:[number], Cancelled:[boolean], CancelReason:[string] }