SearchProjectPreferenceType

The SearchProjectPreference type is used for project search.

Property

Type

Description

Required

Default

startSearchPosition

Integer

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

Yes

0

maximumProjectsToShow

Integer

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

Yes

N/A

projectNameContains

String

String contained in the project name of the projects that you want to search for.

No

N/A

projectTypeNames

String[]

List of project type names you want to search for.

No

N/A

projectRegionNames

String[]

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

No

N/A

associatedProgramNames

String[]

List of program names associated with the projects that you want to search for.

No

N/A

projectManagerUserNames

String

List of project manager user names of the projects you want to search for.

No

N/A

isIncludeFinishProject

boolean

Determines whether the search result should include finished projects.

No

N/A

plannedStartFrom

dateTime

Start from date for the project you want to search for.

No

N/A

plannedStartTo

dateTime

Start to date for the project you want to search for.

No

N/A

plannedFinishFrom

dateTime

Finish from date for the project you want to search for.

No

N/A

plannedFinishTo

dateTime

Finish to date for the project you want to search for.

No

N/A

projectHealth

String[]

List of project health information you want to search for. Valid values for project health are:

  • RED

  • YELLOW

  • GREEN

  • NONE

No

N/A