Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetWorkflowHistory

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetWorkflowHistory

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetWorkflowHistory

Gets the workflow instance history.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetWorkflowHistory

Element Name	Element Type	Restrictions	Description
■ parameters
□ BlockSize	xs:int	nillable	Sets the number of the workflow history entries to return. If not set the whole history will be loaded.
□ IncludeRoutingInfo	xs:boolean	nillable	Include information about which routes the instance has been taken through the workflow process
■ InstanceNo	xs:int	mandatory	Sets the number of the instance which history is being loaded.
□ MaxCreationDate	xs:dateTime	nillable	Sets the date and time that is used to select those history entries which have a smaller creation date. If not set the current time will be used.
□ SeqPos	xs:int	nillable	Sets the sequence position of the first history entry in the returned block.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetWorkflowHistoryResponse

Element Name	Element Type	Restrictions	Description
■ parameters
■ HasRemainingRows	xs:boolean		Indicates whether the history is fully loaded or not.
□ HistoryEntries		nillable	Gets the list, history events.
≡ WSWFHistoryEntry		list nillable
□ ActionDate	xs:dateTime	nillable	Gets the date and time the history entry was created.
■ SeqPos	xs:int		Gets the sequence position of the history entry in the history.
□ TaskName	xs:string	nillable	Gets the name of the task where the history entry was created.
■ TaskNo	xs:int		Gets the number of the task where the history entry was created.
■ TaskToNo	xs:int		Gets the number of the task where the workflow instance was routed to. This property is only set if type is RoutingEntry or ReroutingEntry.
□ Text	xs:string	nillable	Gets the text for the history entry.
■ Type		restriction enum (xs:string) - WFStartEntry (1) - WFFinishedEntry (2) - SaveEntry (3) - RoutingEntry (4) - ClaimEntry (5) - UnclaimEntry (6) - ReclaimEntry (7) - DelegateEntry (8) - DocLinkedEntry (9) - DocLinkRemovedEntry (10) - OverdueMailEntry (11) - OverdueRoutingEntry (12) - ReroutingEntry (13) - CustomEntry (99)	Gets the type of the entry. - If type is CustomEntry then check CustomEntryTypeNumber for more detailed info.
□ UserName	xs:string	nillable	Gets the user name of the user who caused the history entry.
■ UserNo	xs:int		Gets the Therefore™ user number of the user who caused the history entry.
■ CustomEntryTypeNumber	xs:int		Gets the type number of the custom entry. - Value 14 means that the current history entry describes a WF split task. - Value 15 means that the current history entry describes a WF merge task. - Value 16 means that the current history entry describes a WF exception merge task. - Value 17 means that the current history entry describes a WF user split task. - Value 18 means that the current history entry describes a WF error.
□ ActionDateISO8601	xs:string	nillable	Gets the date and time the history entry was created (in ISO 8601 format, UTC).

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.