Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Claims the workflow instance.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  InstanceNo

xs:int

mandatory

Sets the unique instance number of the workflow instance.

â–  TokenNo

xs:int

mandatory

Sets the number for the workflow token. 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/ClaimWorkflowInstanceResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ClaimedByUserName

xs:string

nillable

If the instance is already claimed, it returns the username of the user who has currently claimed the instance. Otherwise an empty string is returned.

â–  IsAlreadyClaimed

xs:boolean

 

Returns true if the instance is already claimed.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.