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.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ ChecklistItems		optional nillable	Gets the checklist items.
≡ WSWFChecklistItem		optional unbounded nillable
■ Checked	xs:boolean	optional	Gets the status of the checklist item.
■ SeqPos	xs:int	optional	Gets the sequence position of this checklist item in the whole checklist.
■ TaskNo	xs:int	optional	Gets the number of the task this checklist item belongs to.
□ Text	xs:string	optional nillable	Gets the text to display this checklist item.
□ HistoryEntries		optional nillable	Gets the list, history events.
≡ WSWFHistoryEntry		optional unbounded nillable
□ ActionDate	xs:dateTime	optional nillable	Gets the date and time the history entry was created.
■ SeqPos	xs:int	optional	Gets the sequence position of the history entry in the history.
□ TaskName	xs:string	optional nillable	Gets the name of the task where the history entry was created.
■ TaskNo	xs:int	optional	Gets the number of the task where the history entry was created.
■ TaskToNo	xs:int	optional	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	optional nillable	Gets the text for the history entry.
■ Type		optional 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	optional nillable	Gets the user name of the user who caused the history entry.
■ UserNo	xs:int	optional	Gets the Therefore™ user number of the user who caused the history entry.
■ CustomEntryTypeNumber	xs:int	optional	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.
□ LinkedDocuments		optional nillable	Gets the list of linked documents.
≡ WSWFDocument		optional unbounded nillable
■ CaseDefNo	xs:int	optional	Gets the case definition number of the linked workflow case.
■ CaseNo	xs:int	optional	Gets the case number of the linked workflow case.
■ CategoryNo	xs:int	optional	Gets the number of the category the linked workflow document belongs to.
■ DocNo	xs:int	optional	Gets the document number of the linked workflow document.
■ DocPos	xs:int	optional	Gets the sequence position of the linked workflow document in the linked documents list.
□ IndexDataString	xs:string	optional nillable	Gets the index data string of the linked workflow document.
□ NextTasks		optional nillable	Gets the list of the next tasks.
≡ WSWFTask		optional unbounded nillable
■ AllowMultiSelection	xs:boolean	optional	Determines if more than one user can be selected for the task.
■ AskForPwd	xs:boolean	optional	Determines if the user has to enter his password in order to complete the task.
■ AssignFromFieldNo	xs:int	optional	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	optional	Gets the number of TheWFChoice objects in the workflow instance.
□ Choices		optional nillable	Gets the list of choices in the workflow instance.
≡ WSWFChoice		optional unbounded nillable
■ TaskNo	xs:int	optional	Gets or sets task number.
□ UserName	xs:string	optional nillable	Gets or sets user name.
■ UserNo	xs:int	optional	Getrs or sets user number.
■ UserType	xs:int	optional	Gets or sets user type.
□ DisplayName	xs:string	optional nillable	Gets or sets user displayname.
■ Duration	xs:int	optional	Gets the maximum duration for the task in days.
■ Guid	xs:string	optional 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	optional	Determines if delegating the task is allowed or not.
□ Name	xs:string	optional nillable	Gets the short name for the task.
■ ProcessNo	xs:int	optional	Gets the process number of the process the task belongs to.
■ SeqPos	xs:int	optional	Gets the sequence position of the task in the process definition.
■ Type		optional restriction enum (xs:string) - StartTask (1) - EndTask (2) - ManualTask (3) - AutomaticTask (4)	Gets the type of the task.
■ UseChecklist	xs:boolean	optional	Determines if the user info is used as checklist.
■ UserChoice	xs:boolean	optional	Determines if the user the task will be assigned to has to be chosen.
■ VersionNo	xs:int	optional	Gets the version number of the workflow process the task belongs to.
■ TaskNo	xs:int	optional	Gets the unique number of the task.
□ ActionTypeId	xs:string	optional nillable	Gets the action type id of the task. (sample values: 'sendmail', 'changecat', 'startwf', 'routing', 'wait', 'updateixdataex', ...).
□ Transitions		optional nillable	Gets the list of transitions.
≡ WSWFTransition		optional unbounded nillable
□ ActionText	xs:string	optional nillable	Gets the text describing the action behind this transition.
■ IsDefault	xs:boolean	optional	Gets information if this transition is default or not.
■ IsHidden	xs:boolean	optional	Gets information if this transition is hidden or not.
■ IsValid	xs:boolean	optional	Gets information if this transition is currently valid for the loaded Workflow Instance (depending on the conditions defined).
■ RequestInfo	xs:boolean	optional	Gets information if the user needs to add a comment before he or she can finish the task.
■ SeqPos	xs:int	optional	Gets the sequence position of the transition in a transition list.
■ TaskFromNo	xs:int	optional	Gets the task number of the task from which this transition starts.
■ TaskToNo	xs:int	optional	Gets the task number of the task in which this transition ends.
□ Description	xs:string	optional nillable	Gets the description of the transition
□ WorkflowInstance		optional nillable	Gets the workflow instance properties.
■ AskForPwd	xs:boolean	optional	Determines if the user has to enter his password in order to complete the current task.
□ AssignedTo	xs:string	optional nillable	Gets the user name of the user the instance is currently assigned to.
■ ChecklistItemCount	xs:int	optional	Gets the number of check list items in the workflow instance.
■ Claimed	xs:boolean	optional	Gets the claimed status of the instance.
□ CurrTaskName	xs:string	optional nillable	Gets the name of the current workflow task for the instance.
■ CurrTaskNo	xs:int	optional	Gets the number of the current workflow task for the instance.
■ CurrTaskType	xs:int	optional	Gets the type of the current task.
■ DelegationDisabled	xs:boolean	optional	Determines if delegating the current task is allowed or not.
■ HistoryEntryCount	xs:int	optional	Gets the number of history entries in the workflow instance.
■ InitiatorNo	xs:int	optional	Gets the user number of the user who started the workflow instance.
■ InstanceNo	xs:int	optional	Gets the unique instance number of the workflow instance.
■ IsAssignedToUser	xs:boolean	optional	Determines if the user is in the list of potential claimants for the instance.
■ IsChangeCtgry	xs:boolean	optional	Determines if the current task is a category change task.
■ IsProcessOwner	xs:boolean	optional	Determines if the current user has process owner rights for the workflow instance.
■ LinkedDocCount	xs:int	optional	Gets the number of linked documents in the workflow instance.
■ NextTaskCount	xs:int	optional	Gets the number of next tasks in the workflow instance.
□ ProcessDueDate	xs:dateTime	optional nillable	Gets the date when the current workflow instance should be finished (routing / processing).
□ ProcessName	xs:string	optional nillable	Gets the name of the workflow process the instance belongs to.
■ ProcessNo	xs:int	optional	Gets the number of the workflow process the instance belongs to.
□ ProcessStartDate	xs:dateTime	optional nillable	Gets the date when the current workflow instance was started.
□ TaskDueDate	xs:dateTime	optional nillable	Gets the date when the current task instance should be finished.
□ TaskStartDate	xs:dateTime	optional nillable	Gets the date when the current task instance was started.
□ Text	xs:string	optional nillable	Gets the long additional text information for the current workflow instance.
■ TokenNo	xs:int	optional	The unique number of the current workflow token.
■ TransitionCount	xs:int	optional	Gets the number of transitions in the workflow instance.
■ UseChecklist	xs:boolean	optional	Determines if the user instructions are displayed as a checklist.
■ VersionNo	xs:int	optional	Gets the version number of the workflow process the instance belongs to.
□ ErrorInfo	xs:string	optional nillable	The error info of the current workflow.
□ ErrorString	xs:string	optional nillable	The error code of the current workflow.
□ ErrorTimestamp	xs:dateTime	optional nillable	The error timestamp of the current workflow.
□ AssignedToUsers		optional nillable	Gets list of claimants for the instance.
≡ UserNo	xs:int	optional unbounded
□ OriginallyAssignedToUsers		optional nillable	Gets list of original claimants for the instance.
≡ UserNo	xs:int	optional unbounded
□ CurrentTask		optional nillable	Gets the current workflow task for the instance.
■ AllowMultiSelection	xs:boolean	optional	Determines if more than one user can be selected for the task.
■ AskForPwd	xs:boolean	optional	Determines if the user has to enter his password in order to complete the task.
■ AssignFromFieldNo	xs:int	optional	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	optional	Gets the number of TheWFChoice objects in the workflow instance.
□ Choices		optional nillable	Gets the list of choices in the workflow instance.
≡ WSWFChoice		optional unbounded nillable
■ TaskNo	xs:int	optional	Gets or sets task number.
□ UserName	xs:string	optional nillable	Gets or sets user name.
■ UserNo	xs:int	optional	Getrs or sets user number.
■ UserType	xs:int	optional	Gets or sets user type.
□ DisplayName	xs:string	optional nillable	Gets or sets user displayname.
■ Duration	xs:int	optional	Gets the maximum duration for the task in days.
■ Guid	xs:string	optional 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	optional	Determines if delegating the task is allowed or not.
□ Name	xs:string	optional nillable	Gets the short name for the task.
■ ProcessNo	xs:int	optional	Gets the process number of the process the task belongs to.
■ SeqPos	xs:int	optional	Gets the sequence position of the task in the process definition.
■ Type		optional restriction enum (xs:string) - StartTask (1) - EndTask (2) - ManualTask (3) - AutomaticTask (4)	Gets the type of the task.
■ UseChecklist	xs:boolean	optional	Determines if the user info is used as checklist.
■ UserChoice	xs:boolean	optional	Determines if the user the task will be assigned to has to be chosen.
■ VersionNo	xs:int	optional	Gets the version number of the workflow process the task belongs to.
■ TaskNo	xs:int	optional	Gets the unique number of the task.
□ ActionTypeId	xs:string	optional nillable	Gets the action type id of the task. (sample values: 'sendmail', 'changecat', 'startwf', 'routing', 'wait', 'updateixdataex', ...).

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.