WFGetHistory WFGetHistory
This call returns the list of Groups defined. You can view the XML input and output parameters, which have to be passed for fetching the list and displaying it. There is a list of errors and warning that can occur in the execution.
* implies for the mandatory parameter.
|
Name |
Parent Tag |
Description |
Valid Value |
|
Option * |
Root |
It refers to the case sensitive call name. |
case sensitive call name. |
|
EngineName * |
Root |
It is the cabinet or database name, which has to be connected. |
NA |
|
SessionID * |
Root |
It is the logged in user session id |
NA |
|
ActionId |
Root |
Index of the action to be fetched |
Actionid = 1 // Processinstance created Actionid = 2 // Processinstance started or introduced Actionid = 3 // Processinstance discarded Actionid = 4 // Processinstance routed from one workstep to another workstep Actionid = 5 // Processinstance aborted Actionid = 6 // Processinstance distributed to multiple worksteps Actionid = 7 // Workitem locked Actionid = 8 // Workitem unlocked Actionid = 9 // Exception raised Actionid = 10 // Exception cleared Actionid = 15 // ToDo item modified Actionid = 16 // Attribute set Actionid = 17 // Workitem reassigned Actionid = 18 // DocumentType added Actionid = 19 // DocumentType annotated Actionid = 20 // Processinstance completed Actionid = 21 // Process state changed enable and disable Actionid = 22 // Some action performed Actionid = 23 // User logged in Actionid = 24 // User logged out Actionid = 25 // Processinstance Terminated Actionid = 26 // Processinstance state changed Actionid = 27 // Workitem completed Actionid = 28 // Workitem expired Actionid = 32 // Workitem Audit rejected Actionid = 33 // Workitem Audit accepted Actionid = 34 // Workitem Audit Set Actionid = 36 // workitem linked to other workitem Actionid = 37 // workitem delinked to other workitem Actionid = 38 // Workitem reinitiated Actionid = 39 // Processinstance deleted Actionid = 40 // Get linked workitems Actionid = 41 // Workitem reffered Actionid = 42 // Workitem revoked Actionid = 43 // Workitem submitted Actionid = 44 // Processinstance create new processinstance of subprocess Actionid = 45 // workitem adhoc routed Actionid = 46 // New processinstance created as subprocess Actionid = 47 // Reminder on workitem set Actionid = 48 // Reminder om workitem deleted Actionid = 49 // LOg deleted Actionid = 50 // Add Queue Actionid = 51 // Change Queue
Actionid = 52 // Delete Queue Actionid = 53 // Diversion set for user Actionid = 54 // Diversion deleted for user Actionid = 57 // Document of workitem Printed Actionid = 58 // Document of workitem faxed Actionid = 59 // Document of workitem mailed Actionid = 60 // User added to queue Actionid = 61 // User deleted from queue Actionid = 62 // workstep added to queue Actionid = 63 // workstep deleted from queue Actionid = 64 // Add preferred queue for a user Actionid = 65 // delete preferred queue for a user Actionid = 66 // Add alias to Queue Actionid = 67 // delete alias from Queue Actionid = 68 // Set process turnaroundtime Actionid = 69 // Set activity turnaroundtime |
|
HistoryOption |
Root |
Option to fetch history. |
Q - Queue History P - Process History U - User History |
|
OptionIndex |
Root |
Index of the corresponding option to fetch history |
NA |
|
NoOfRecordsToFetch |
Root |
It is the batch size for the process to be fetched. |
NA |
|
LastIndex |
Root |
Index of the last item in the list |
NA |
|
SortOrder |
Root |
It is the sort order for records |
"A"= ascending "D" = Descending |
|
From |
Root |
It is the date from which the history to be fetched |
NA |
|
To |
Root |
It is the date till which the history to be fetched |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
ActivityId |
HistoryInfo |
It is the activity id for the workitem. |
|
ActivityName |
HistoryInfo |
It is the activity name for the workitem. |
|
UserId |
HistoryInfo |
It is the user id which has performed the action. |
|
Username |
HistoryInfo |
It is the user name which has performed the action. |
|
ActionId |
HistoryInfo |
It is the action id. |
|
ActionDateTime |
HistoryInfo |
It is the date/time on which the action is performed. |
|
FieldId |
HistoryInfo |
Any numeric information corresponding to the actionid. |
|
FieldName |
HistoryInfo |
Any text information corresponding to the actionid. |
|
WorkItemId |
HistoryInfo |
It is the workitem id on which the action is performed.. |
|
ProcessInstanceId |
HistoryInfo |
It is the processinstance id on which the action is performed. |
|
LogId |
HistoryInfo |
It is the log id of the action performed.. |
|
TotalCount |
Root |
Total count of history items on current retrieval. |
|
RetrievedCount |
Root |
Total history items retrieved. |
|
Code |
Constant Value |
Message |
|
18 |
WM_NO_MORE_DATA |
No more records. |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |
|
400 |
WF_OPERATION_FAILED |
The requested operation failed. |