Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Starts a new task.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Task

 

mandatory nillable

Sets parameters for a new task.

â–¡ AssignTo

 

mandatory nillable

Gets or sets a list of users the task is assigned to. If it is an empty list (count = zero) the task will be assigned to the current/connected user.

≡ WSUserByQuery

 

list nillable


â–¡ DomainName

xs:string

nillable

Sets the domain name of the user or user group.

â–¡ FilterFlag

 

nillable

restriction enum (xs:string)

- FindUsersInActiveDirectory (1)

- FindUsersInTherefore (4)

- FindAllUsers (5)

- FindUsersNotInTherefore (32)

- FindGroupsInActiveDirectory (64)

- FindGroupsInTherefore (256)

- FindAllGroups (320)

- FindAllUsersAndGroups (325)

- FindGroupsNotInTherefore (1024)

- FindSMTPUsersOnly (4096)

Sets filter determining where the user/group should be taken from.

â–¡ UserId

xs:int

nillable

Gets or sets the ID of a Thereforeâ„¢ user. Only Thereforeâ„¢ users have a unique user ID assigned. For all other users the default value 0 will be returned. If UserID is set the other parameters (UserName, DomainName, FilterFlag) are not required.

â–¡ UserName

xs:string

nillable

Gets or sets the user name of the user or user group.

â–¡ CaseNo

xs:int

nillable

Gets or sets the case number of the case this task belongs to.

â–¡ DocNo

xs:int

nillable

Gets or sets the document number of the document this task belongs to.

â–¡ DueDate

xs:dateTime

nillable

Gets or sets the due date of the task.

â–¡ Instructions

xs:string

nillable

Gets the instruction text.

â–  Mode

 

mandatory

restriction enum (xs:string)

- Complete (1)

- CompleteDecline (2)

- ApproveReject (3)

- YesNo (4)

Gets the mode of the task.

â–  NotifyOnAssign

xs:boolean

 

Gets or sets whether or not the users the task is assigned to will be notified via e-mail.

â–  NotifyOnUpdate

xs:boolean

 

Gets or sets whether or not the task owner will be notified via e-mail when the task has been updated.

â–¡ StartDate

xs:dateTime

nillable

Gets the start date of the task.

â–¡ Subject

xs:string

mandatory nillable

Gets or sets the subject of the task.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  TaskNo

xs:int

 

Gets number of new task.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.