Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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.

 

 

© 2023 Therefore Corporation, all rights reserved.