Services Integration Framework Guide

10.3 HotFix 1
- 10.5
- 10.4 HotFix 3
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 3
- 10.3 HotFix 2
- 10.3

Back Next

GetTasks

The

GetTasks

API retrieves a lists of tasks and task details. Optional parameters allow you to filter the tasks that

GetTasks

returns.

Required Parameters

The

GetTasks

request does not have required parameters.

Optional Parameters

Use the optional parameters to filter the list of tasks that

GetTasks

returns. The following table describes the optional parameters.

Parameter	Description
TaskMetadata	Contains the filter criteria to apply to tasks for the search. By default, GetTasks searches for tasks with priority=NORMAL and status=OPEN. To search for tasks with other priorities or statuses, specify the priority and status in the TaskMetadata parameter.
OverdueOnly	If set to true , GetTasks only returns tasks with due dates that have already passed.
SummaryOnly	If set to true , GetTasks only returns the task metadata. The records and comments associated with the task are not returned.
Unassigned	If set to true , GetTasks only returns unassigned tasks.
CanBeAssignedToUser	If set to true , GetTasks only returns tasks that can be assigned to the user specified in the GetTasks request.
BDDApplicationName	If set to true , GetTasks only returns tasks for an IDD instance.
DisablePaging	The default value of DisablePaging is false . If set to false , paging is enabled and a search token is returned. Use GetSearchResults to fetch subsequent pages of search results. If set to true , paging is disabled.

Response Fields

The

GetTasks

response returns a list of tasks that are filtered by the parameters specified in the

GetTasks

request. If DisablePaging is set to

false

, a search token is also returned.

Use Case

This is the common scenario for using the

GetTasks

request:

Fetch a set of tasks that match the criteria specified in the request.

GetTasks Request Usage Example

The following example retrieves the overdue tasks assigned to the user named 'admin'.

GetTasksRequest request = new GetTasksRequest();
TaskMetaData taskMetadata = new TaskMetaData();
taskMetadata.setOwnerUid("USER.admin");
request.setTaskMetaData(taskMetadata);
request.setOverdueOnly(true);
GetTasksResponse response = (GetTasksResponse) sipClient.process(request);

Use the following line of code to return tasks with a priority of 1:

taskMetadata.setPriority(1);

Use the following line of code to return the task that has a task ID of '1234':

taskMetadata.setTaskId("1234");

GetTasks Response Usage Example

The code in the following example shows how to print out the records returned by the

GetTasks

response.

GetTasksResponse response = new GetTasksResponse();
int i=0; 
for(Iterator iter=response.getTaskList().iterator(); iter.hasNext();)
{ //iterate through response records 
  System.out.println("Printing task " + i);
  TaskMetaData task = (TaskMetaData) iter.next(); 
  System.out.println(task.getTitle()+", "+task.getTaskType()+", "+task.getStatus()); 
}