Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.