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

GetLinkedWorkflowsForDoc

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

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

Gets list of workflow for given document.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ DocNo	xs:int	mandatory	The document number.
■ WFDocLinkType		mandatory restriction enum (xs:string) - Any (0) - MainDocument (1) - AdditionalDocument (2)	The type of the link.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ InfoLists		nillable	Gets list of linked workflow instances info.
≡ WSWFInstanceInfo		list nillable
□ AssignedTo	xs:string	nillable	Gets the user name of the user the instance is currently assigned to.
■ Claimed	xs:boolean		Gets the claimed status of the instance.
□ CurrTaskName	xs:string	nillable	Gets the name of the current workflow task of the instance.
■ CurrTaskNo	xs:int		Gets the number of the current workflow task for the 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.
■ LinkType		restriction enum (xs:string) - Any (0) - MainDocument (1) - AdditionalDocument (2)	Gets the type of the link.
□ 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 of the instance.
■ ProcessNo	xs:int		Gets the number of the workflow process of the instance.
□ 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.
■ TokenNo	xs:int		The unique number for the current workflow token.
■ VersionNo	xs:int		Gets the version number of the workflow process of the instance.
□ 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.
□ 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).

Legend:

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