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

GetTask

Scroll

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

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

Gets the Task details by task number.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ TaskNo	xs:int	mandatory	Sets the number of the task.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ Task		nillable	Gets the task properties.
□ AssignTo		mandatory nillable	Gets or sets a list of users the task is assigned to.
≡ WSUser		list nillable
□ Description	xs:string	nillable	Gets or sets the description of the user or user group.
□ DisplayName	xs:string	nillable	Gets or sets the display name of the user or user group.
□ DomainName	xs:string	nillable	Gets or sets the domain name of the user or user group.
□ InFolder	xs:string	nillable	Gets or sets the name of the folder the user or user group belongs to.
□ SMTP	xs:string	nillable	Gets or sets the SMTP email address of the user or user group.
□ 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.
□ UserName	xs:string	nillable	Gets or sets the user name of the user or user group.
□ UserType		nillable restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets or sets the type of the user or user group.
■ Disabled	xs:boolean		Gets or sets whether the user is disabled or not.
□ GUID	xs:string	nillable	Gets or sets the GUID of the user.
■ OneTimePwd	xs:boolean		Gets or sets whether the user has to change his password on his next log in or not.
■ DocNo	xs:int	mandatory	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.
□ TaskNo	xs:int	nillable	Gets or sets the ID of the task.
■ UserNo	xs:int		Gets or sets the id of the task creator.
■ CaseNo	xs:int		Gets or sets the case number of the case this task belongs to.
□ DueDateISO8601	xs:string	nillable	Gets or sets the due date of the task (date in ISO 8601 format, example 2024-01-23).
□ StartDateISO8601	xs:string	nillable	Gets the start date of the task (date in ISO 8601 format, example 2024-01-23).

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.