Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Executes the query.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  MaxRows

xs:int

 

Sets the maximum number of rows to retrieve from the server.

â–  QueryMode

 

mandatory

restriction enum (xs:string)

- Normal (0)

- AllStarted (1)

- AllParticipated (2)

Sets the mode of the query.

â–¡ TaskNo

xs:int

nillable

Sets the ID of a task.

â–  ViewMode

 

mandatory

restriction enum (xs:string)

- AllTasks (0)

- Today (1)

- Next7 (2)

- Overdue (3)

- NotStarted (4)

- Active (5)

- Completed (6)

Sets the view mode of the query.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ QueryResult

 

nillable

Gets the information found by the query.

≡ WSTaskInfo

 

list nillable


â–¡ AssignedToName

xs:string

nillable

Gets the name of the user the task is assigned to.

â–  AssignedToNumber

xs:int

 

Gets the ID of the user the task is assigned to.

â–¡ Comment

xs:string

nillable

Gets the comment of the task.

â–  CompletedDecision

 

 

restriction enum (xs:string)

- Undefined (0)

- Positive (1)

- Negative (2)

Gets the task completed decision.

â–¡ CreatedBy

xs:string

nillable

Gets the name of the task creator.

â–  DocNo

xs:int

 

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

â–¡ DueDate

xs:dateTime

nillable

Gets the due date of the task.

â–¡ Instructions

xs:string

nillable

Gets the instruction text.

â–  IsAssignedToUser

xs:boolean

 

Gets whether or not the task is assigned to the currently active user.

â–  LastUpdate

xs:dateTime

 

Gets the date of the last update of the task.

â–  Mode

 

 

restriction enum (xs:string)

- Complete (1)

- CompleteDecline (2)

- ApproveReject (3)

- YesNo (4)

Gets the mode of the task.

â–¡ StartDate

xs:dateTime

nillable

Gets the start date of the task.

â–  Status

 

 

restriction enum (xs:string)

- NotStartedStatus (1)

- InProgressStatus (2)

- WaitingStatus (3)

- DeferredStatus (4)

- CompletedStatus (5)

- RevokedStatus (6)

Gets the status of the task.

â–¡ Subject

xs:string

nillable

Gets the subject of the task.

â–  TaskNo

xs:int

 

Gets the ID of the task.

â–  IsCreatedByUser

xs:boolean

 

Gets whether or not the task is created by currently active user.

â–  CaseNo

xs:int

 

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

â–¡ DueDateISO8601

xs:string

nillable

Gets the due date of the task (date in ISO 8601 format, example 2024-01-23).

â–¡ LastUpdateISO8601

xs:string

nillable

Gets the date of the last update of the task (in ISO 8601 format, UTC).

â–¡ 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.

 

 

© 2024 Therefore Corporation, all rights reserved.