Forecast
- Cam Mackay
Overview
Provides access to Forecast related data.
Endpoints
The resources available in this module.
ForecastAdjustmentDetailApi
Provides API access to the Uncomitted Adjustments and Risk Adjustments dialogs on the Job Contract (#/General/JobList.aspx/JobContract?JobCode=[HeaderJobCode]&JobContractTabs=ForecastTab) Web Workbench screen.
/api/ForecastAdjustmentDetailApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET | Logged in User | - | ||
POST | Logged in User | - | ||
Models
The definitions of models specific to endpoints in this module.
ForecastAdjustmentKey
Property | Data Type | Description | Note |
|---|---|---|---|
RiskType | Integer | The Risk Type of the Adjustments: either 1 ('Risk Adjustment') or 2 ('Uncommitted Adjustment')" | Required. |
HeaderJobCode | String | The Header Job the Forecast is for. | Required. |
YearNo | Integer | The Year of the Forecast. | Required. |
PeriodNo | Integer | The Period of the Forecast. | Required. |
JobCode | String | The Job on the Forecast line. | Required. |
WorkCentreCode | String | The Work Centre on the Forecast line. | Required. |
CostCategoryID | Integer | The Cost Category on the Forecast line. | Optional. |
ActivityCode | String | The Activity on the Forecast line. | Optional. |
ForecastAdjustmentApiModel
Property | Data Type | Description |
|---|---|---|
Key | The unique key of the Forecast Line. | |
ForecastAdjustment | The adjustment data associated with the Forecast line. | |
SuccessMessage | String | A success message if the save was successful. |
ValidationErrors | Array<MvcValidationError> | A list of specific validation errors if the save was unsuccessful. |
ForecastAdjustmentDetail
Property | Data Type | Description |
|---|---|---|
Rows | Array<ForecastAdjustmentLine> | The Forecast Adjustments on the Forecast line. |
MovementSummaryRows | Array<ForecastAdjustmentMovementLine> | The Forecast Movement Summary lines. (readonly) |
ForecastAdjustmentFields | The details of the Forecast line. (optional) |
ForecastAdjustmentFields
Property | Data Type | Description |
|---|---|---|
Comments | The Comment on the Forecast line. Only available at Activity Level. | |
ForecastPeriod | The Forecast Period of the Forecast. | |
Reviewed | The Reviewed flag on the Forecast line. | |
Completed | The Completed flag on the Forecast line. |