SearchTaskPreferenceType

The SearchTaskPreferenceType data type is used for task search:

Property

Type

Description

Required

Default

startSearchPosition

Integer

Start position of the task in the search result. This is used in paged search. Starts at position 1.

Yes

N/A

maximumTasksToShow

Integer

Number of tasks to be returned for the search criteria. Values range from 1 to 1,000 inclusively.

Yes

N/A

taskNamePrefix

String

String the task name starts with.

No

N/A

projectNames

String[]

List of project names of the tasks that you want to search for.

No

N/A

resourceUserNames

String[]

List of resource user names of the tasks that you want to search for.

No

N/A

showOnlyMileStone

boolean

Determines whether the search result should show only milestone tasks.

No

N/A

showOnlyExceptionTask

boolean

Determines whether the search result should show only tasks with exceptions.

No

N/A

includeFinishedTask

boolean

Determines whether the search result should include finished tasks.

No

N/A

scheduledStartFrom

dateTime

Schedules the Start from date for the task you want to search for.

No

N/A

scheduledStartTo

dateTime

Schedules the Start to date for the task you want to search for.

No

N/A

scheduledFinishFrom

dateTime

Schedules the Finish from date for the task you want to search for.

No

N/A

scheduledFinishTo

dateTime

Schedules the Finish to date for the task you want to search for.

No

N/A