PwsGetBaselineBucketDateIntervals
Overview
This web service retrieves baseline bucket date intervals given an interval count, start date and time phase. This is intended to be used to facility creation of time and cost baselines. The response to this web service will be a list of bucket date intervals, each consisting of a start date and an end date. These are the dates that PwsCreateProjectCostBaseline, PwsUpdateProjectCostBaseline, PwsCreateProjectTimeBaseline and PwsUpdateProjectTimeBaseline will expect as bucket dates when creating or updating baselines.
Request Format
- PwsGetBaselineBucketDateIntervals
- serviceRequest: PwsGetBaselineBucketDateIntervalsRq
- RequestId: Int32
- SessionTicket: String
- IntervalCount: Int32
- StartDate: DateTime
- TimePhase: String
- serviceRequest: PwsGetBaselineBucketDateIntervalsRq
Request Elements
Element | Data Type | Required? | Description | Sample Data |
---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 |
SessionTicket | String | Yes | Click here for more information. | AbHODMrb8ng+PCV+B7BzmQ== |
IntervalCount | Int32 | Yes - unless TimePhase = 'N' for None | The number of intervals in the baseline. | 3Â |
StartDate | DateTime | Yes - unless TimePhase = 'N' for None | The start date (in UTC format) of the first bucket in the baseline. | 2018-01-01T00:00:00.000Z |
TimePhase | String | Yes | Â The time phase of the baseline. Valid values are D for Daily, W for Weekly, H for Hourly, M for Monthly, Q for Quarterly, Y for Yearly, and N for None. | M |
Request Usage Example(s)
Response Format
- PwsGetBaselineBucketDateIntervalsResponse
- PwsGetBaselineBucketDateIntervalsResult: PwsGetBaselineBucketDateIntervalsRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- BaselineBucketDateIntervals: PwsDateInterval[]
- PwsGetBaselineBucketDateIntervalsResult: PwsGetBaselineBucketDateIntervalsRs
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information | 1 |
Status | Click here for more information | Ok | |
ServerTimestampUtc | DateTime | Click here for more information | 2018-03-15T17:03:19.430982Z |
BaselineBucketDateIntervals | The baseline bucket date intervals (in UTC format) |
Response Usage Example(s)
PwsGetBaselineBucketDateIntervals - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
34004 | InvalidValueForBaselineTimePhase | The value specified for baseline time phase is invalid. Valid values are D for Daily, W for Weekly, H for Hourly, M for Monthly, Q for Quarterly, Y for Yearly, and N for None. |
34007 | ParametersIgnoredForTimePhaseNone | Time Phase Parameters StartDate and IntervalCount are ignored when Time Phase specified as N for None. |
34008 | IllegalNullStartDateForTimePhase | Time Phase may not have a null Start Date. |
34009 | IllegalIntervalCountForTimePhase | Time Phase must have a positive non-zero Interval Count. |