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

GetWorkflowInstance

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

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

Gets the workflow instance by number.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ InstanceNo	xs:int	mandatory	Sets number of the instance to load from the Therefore™ server.
■ TokenNo	xs:int	mandatory	Sets the number for the workflow token to load. If set to 0, the server will try to find the closest matching token.
■ IsAccessMaskNeeded	xs:boolean		Sets to true if the access mask for the parent workflow process should be returned in response.
□ LoadHistory	xs:boolean	nillable	Specifies weather the workflow history should be loaded with the instance or not.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ ChecklistItems		nillable	Gets the checklist items.
≡ WSWFChecklistItem		list nillable
■ Checked	xs:boolean		Gets the status of the checklist item.
■ SeqPos	xs:int		Gets the sequence position of this checklist item in the whole checklist.
■ TaskNo	xs:int		Gets the number of the task this checklist item belongs to.
□ Text	xs:string	nillable	Gets the text to display this checklist item.
□ 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).
□ LinkedDocuments		nillable	Gets the list of linked documents.
≡ WSWFDocument		list nillable
■ CaseDefNo	xs:int		Gets the case definition number of the linked workflow case.
■ CaseNo	xs:int		Gets the case number of the linked workflow case.
■ CategoryNo	xs:int		Gets the number of the category the linked workflow document belongs to.
■ DocNo	xs:int		Gets the document number of the linked workflow document.
■ DocPos	xs:int		Gets the sequence position of the linked workflow document in the linked documents list.
□ IndexDataString	xs:string	nillable	Gets the index data string of the linked workflow document.
□ NextTasks		nillable	Gets the list of the next tasks.
≡ WSWFTask		list nillable
■ AllowMultiSelection	xs:boolean		Determines if more than one user can be selected for the task.
■ AskForPwd	xs:boolean		Determines if the user has to enter his password in order to complete the task.
■ AssignFromFieldNo	xs:int		Gets the field number of the Therefore™ index field, which contains the information about the user this task should be assigned to.
■ ChoiceCount	xs:int		Gets the number of TheWFChoice objects in the workflow instance.
□ Choices		nillable	Gets the list of choices in the workflow instance.
≡ WSWFChoice		list nillable
■ TaskNo	xs:int		Gets or sets task number.
□ UserName	xs:string	nillable	Gets or sets user name.
■ UserNo	xs:int		Getrs or sets user number.
■ UserType	xs:int		Gets or sets user type.
□ DisplayName	xs:string	nillable	Gets or sets user displayname.
■ Duration	xs:int		Gets the maximum duration for the task in days.
■ Guid	xs:string	GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets the GUID of the task.
■ IsDelegationDisabled	xs:boolean		Determines if delegating the task is allowed or not.
□ Name	xs:string	nillable	Gets the short name for the task.
■ ProcessNo	xs:int		Gets the process number of the process the task belongs to.
■ SeqPos	xs:int		Gets the sequence position of the task in the process definition.
■ Type		restriction enum (xs:string) - StartTask (1) - EndTask (2) - ManualTask (3) - AutomaticTask (4)	Gets the type of the task.
■ UseChecklist	xs:boolean		Determines if the user info is used as checklist.
■ UserChoice	xs:boolean		Determines if the user the task will be assigned to has to be chosen.
■ VersionNo	xs:int		Gets the version number of the workflow process the task belongs to.
■ TaskNo	xs:int		Gets the unique number of the task.
□ ActionTypeId	xs:string	nillable	Gets the action type id of the task. (sample values: 'sendmail', 'changecat', 'startwf', 'routing', 'wait', 'updateixdataex', ...).
□ TaskGUID	xs:string	nillable	Gets the task ID of the workflow task which stays stable across multiple versions of the workflow. This can be used to safely identify the same task across multiple versions of the workflow process
□ Transitions		nillable	Gets the list of transitions.
≡ WSWFTransition		list nillable
□ ActionText	xs:string	nillable	Gets the text describing the action behind this transition.
■ IsDefault	xs:boolean		Gets information if this transition is default or not.
■ IsHidden	xs:boolean		Gets information if this transition is hidden or not.
■ IsValid	xs:boolean		Gets information if this transition is currently valid for the loaded Workflow Instance (depending on the conditions defined).
■ RequestInfo	xs:boolean		Gets information if the user needs to add a comment before he or she can finish the task.
■ SeqPos	xs:int		Gets the sequence position of the transition in a transition list.
■ TaskFromNo	xs:int		Gets the task number of the task from which this transition starts.
■ TaskToNo	xs:int		Gets the task number of the task in which this transition ends.
□ Description	xs:string	nillable	Gets the description of the transition
□ WorkflowInstance		nillable	Gets the workflow instance properties.
■ AskForPwd	xs:boolean		Determines if the user has to enter his password in order to complete the current task.
□ AssignedTo	xs:string	nillable	Gets the user name of the user the instance is currently assigned to.
■ ChecklistItemCount	xs:int		Gets the number of check list items in the workflow instance.
■ Claimed	xs:boolean		Gets the claimed status of the instance.
□ CurrTaskName	xs:string	nillable	Gets the name of the current workflow task for the instance.
■ CurrTaskNo	xs:int		Gets the number of the current workflow task for the instance.
■ CurrTaskType	xs:int		Gets the type of the current task.
■ DelegationDisabled	xs:boolean		Determines if delegating the current task is allowed or not.
■ HistoryEntryCount	xs:int		Gets the number of history entries in the workflow instance.
■ InitiatorNo	xs:int		Gets the user number of the user who started the workflow instance.
■ InstanceNo	xs:int		Gets the unique instance number of the workflow instance.
■ IsAssignedToUser	xs:boolean		Determines if the user is in the list of potential claimants for the instance.
■ IsChangeCtgry	xs:boolean		Determines if the current task is a category change task.
■ IsProcessOwner	xs:boolean		Determines if the current user has process owner rights for the workflow instance.
■ LinkedDocCount	xs:int		Gets the number of linked documents in the workflow instance.
■ NextTaskCount	xs:int		Gets the number of next tasks in the workflow instance.
□ ProcessDueDate	xs:dateTime	nillable	Gets the date when the current workflow instance should be finished (routing / processing).
□ ProcessName	xs:string	nillable	Gets the name of the workflow process the instance belongs to.
■ ProcessNo	xs:int		Gets the number of the workflow process the instance belongs to.
□ ProcessStartDate	xs:dateTime	nillable	Gets the date when the current workflow instance was started.
□ TaskDueDate	xs:dateTime	nillable	Gets the date when the current task instance should be finished.
□ TaskStartDate	xs:dateTime	nillable	Gets the date when the current task instance was started.
□ Text	xs:string	nillable	Gets the long additional text information for the current workflow instance.
■ TokenNo	xs:int		The unique number of the current workflow token.
■ TransitionCount	xs:int		Gets the number of transitions in the workflow instance.
■ UseChecklist	xs:boolean		Determines if the user instructions are displayed as a checklist.
■ VersionNo	xs:int		Gets the version number of the workflow process the instance belongs to.
□ ErrorInfo	xs:string	nillable	The error info of the current workflow.
□ ErrorString	xs:string	nillable	The error code of the current workflow.
□ ErrorTimestamp	xs:dateTime	nillable	The error timestamp of the current workflow.
□ AssignedToUsers		nillable	Gets list of claimants for the instance.
≡ UserNo	xs:int	list
□ OriginallyAssignedToUsers		nillable	Gets list of original claimants for the instance.
≡ UserNo	xs:int	list
□ CurrentTask		nillable	Gets the current workflow task for the instance.
■ AllowMultiSelection	xs:boolean		Determines if more than one user can be selected for the task.
■ AskForPwd	xs:boolean		Determines if the user has to enter his password in order to complete the task.
■ AssignFromFieldNo	xs:int		Gets the field number of the Therefore™ index field, which contains the information about the user this task should be assigned to.
■ ChoiceCount	xs:int		Gets the number of TheWFChoice objects in the workflow instance.
□ Choices		nillable	Gets the list of choices in the workflow instance.
≡ WSWFChoice		list nillable
■ TaskNo	xs:int		Gets or sets task number.
□ UserName	xs:string	nillable	Gets or sets user name.
■ UserNo	xs:int		Getrs or sets user number.
■ UserType	xs:int		Gets or sets user type.
□ DisplayName	xs:string	nillable	Gets or sets user displayname.
■ Duration	xs:int		Gets the maximum duration for the task in days.
■ Guid	xs:string	GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets the GUID of the task.
■ IsDelegationDisabled	xs:boolean		Determines if delegating the task is allowed or not.
□ Name	xs:string	nillable	Gets the short name for the task.
■ ProcessNo	xs:int		Gets the process number of the process the task belongs to.
■ SeqPos	xs:int		Gets the sequence position of the task in the process definition.
■ Type		restriction enum (xs:string) - StartTask (1) - EndTask (2) - ManualTask (3) - AutomaticTask (4)	Gets the type of the task.
■ UseChecklist	xs:boolean		Determines if the user info is used as checklist.
■ UserChoice	xs:boolean		Determines if the user the task will be assigned to has to be chosen.
■ VersionNo	xs:int		Gets the version number of the workflow process the task belongs to.
■ TaskNo	xs:int		Gets the unique number of the task.
□ ActionTypeId	xs:string	nillable	Gets the action type id of the task. (sample values: 'sendmail', 'changecat', 'startwf', 'routing', 'wait', 'updateixdataex', ...).
□ TaskGUID	xs:string	nillable	Gets the task ID of the workflow task which stays stable across multiple versions of the workflow. This can be used to safely identify the same task across multiple versions of the workflow process
■ IsSmartCaptureVerification	xs:boolean		Determines if the current task is a Smart Capture Verification task.
□ CurrTaskId	xs:string	nillable	Gets the task ID of the current workflow task for the instance.
□ CurrTaskGUID	xs:string	nillable	Gets the task ID of the current workflow task for the instance, which stays stable across multiple versions of the workflow. This can be used to safely identify the same task across multiple versions of the workflow process
□ ErrorTimestampISO8601	xs:string	nillable	The error timestamp of the current workflow (in ISO 8601 format, UTC).
□ ProcessDueDateISO8601	xs:string	nillable	Gets the date when the current workflow instance should be finished (routing / processing). Date in ISO 8601 format, example 2024-01-23.
□ ProcessStartDateISO8601	xs:string	nillable	Gets the date when the current workflow instance was started (date in ISO 8601 format, example 2024-01-23).
□ TaskDueDateISO8601	xs:string	nillable	Gets the date when the current task instance should be finished (date in ISO 8601 format, example 2024-01-23).
□ TaskStartDateISO8601	xs:string	nillable	Gets the date when the current task instance was started (date in ISO 8601 format, example 2024-01-23).
□ WFProcessRoleAccessMask		nillable	Gets the role access mask for connected user on the parent workflow process.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.

Legend:

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