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

StartTask2

Scroll

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 or sets the start date of the task.
□ Subject	xs:string	mandatory nillable	Gets or sets the subject of the task.
□ DueDateISO8601	xs:string	nillable	Gets or sets the due date of the task (date in ISO 8601 format, example 2024-01-23). DueDateISO86011 is ignored if DueDate parameter is set.
□ StartDateISO8601	xs:string	nillable	Gets or sets the start date of the task (date in ISO 8601 format, example 2024-01-23). StartDateISO8601 is ignored if StartDate parameter is set.

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.