TimeFilter

TimeFilter is holds the parameters which are used to get the work item actuals.

Note: TimeFilter is used as the INPUT in getActualTime.

Property

Type

Description

Required

Default

startDate

Date

Date value of the start of the work item effort.

Yes

N/A

endDate

Date

Date value of the end of the work item effort.

Yes

N/A

periodTypeName

String

String value of the time period type name.

Valid values:

  • Weekly

  • Bi-Weekly

  • Semi-Monthly

  • Monthly

Yes

N/A

workItemType

String

String value of the work item type. Valid values:

  • REQUEST

  • TASK

  • PROJECT

  • PACKAGE

  • MISC

No

N/A

workItemName

String

String value of the work item name.

No

N/A

workItemID

String

String value of the work item ID.

No

N/A

resources

List

List of resources usernames.

No

N/A

timeSheetStatuses

List

List of time sheet statuses.

Constant must correspond to the statuses constants in meaning field of TimeSheetStatus.

No

N/A

timeSheetLineStatuses

List

List of time sheet line statuses

Constant must correspond to the statuses constants in meaning field of TimeSheetLineStatus.

No

N/A

includeActualCost

boolean

True if you want to get the actual cost information in the results, False otherwise.

No

N/A