Therefore Web API Programming Interface 1.0

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.

â–¡ LoadTasks

xs:boolean

nillable

Determines if also information about all workflow tasks should be loaded

â–  IsAccessMaskNeeded

xs:boolean

Sets to true if the access mask for the requested workflow process should be returned in response.

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.

â–¡ Tasks

nillable

Gets the list of all tasks in this process.

≡ 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

â–¡ LastModifiedISO8601

xs:string

nillable

Gets the date and time when the workflow process was modified the last time (in ISO 8601 format, UTC).

â–¡ RoleAccessMask

nillable

Gets the role access mask for connected user.

â–  Value

xs:unsignedLong

Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.