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

GetWorkflowProcess

Scroll

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

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

Gets the workflow process by number.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ ProcessNo	xs:int		The process number of the workflow process definition.
■ VersionNo	xs:int		The version number of the workflow process definition.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ WorkflowProcess		nillable	Gets the workflow process definition.
■ Activated	xs:boolean		Returns whether or not the workflow process is activated.
■ AllowManualStart	xs:boolean		Returns whether or not a workflow instance can be started manually in this workflow process.
■ CaseDefinitionNo	xs:int		Gets the case definition number of the related category.
■ CategoryNo	xs:int		Gets the category number of the related category.
■ DaysToDeleteInstances	xs:int		Gets the number of days until the workflow instance is deleted.
□ DelegateMailText	xs:string	nillable	Gets the mail text that is sent to a user a workflow instance is delegate to.
□ Description	xs:string	nillable	Gets the description text of the workflow process.
■ Duration	xs:int		Gets the duration of a workflow instance in days.
■ Enabled	xs:boolean		Gets the enabled status.
■ FolderNo	xs:int		Gets the number of the folder containing the workflow process.
■ 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 GUID of the process.
■ LastModified	xs:dateTime		Gets the date and time when the workflow process was modified the last time.
□ Name	xs:string	nillable	Gets the workflow process name of the current workflow process.
□ NotificationMailText	xs:string	nillable	Gets the mail text that is sent if an error occurs in a workflow instance.
□ NotifyOnError	xs:string	nillable	Gets the mail address to send the notification email to if an error occurs in a workflow instance.
□ OverdueMailText	xs:string	nillable	Gets the mail text that is sent if a workflow instance is overdue.
■ ProcessNo	xs:int		Gets the process number of the workflow process.
■ VersionNo	xs:int		Gets the version number of the workflow process.

Legend:

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