Update a planning resource for a project forecast version
patch
/fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Request
Path Parameters
- PlanVersionId(required): integer(int64) Identifier of the forecast version.
- PlanningElementId(required): integer(int64) Identifier of the planning resources of the forecast version.
Header Parameters
- Metadata-Context: string If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: string The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object
- MaintainManualSpreadOnDateChanges: string Default Value:
N
Indicates whether the periodic planning is retained in the plan version on plan line date modifications. - PlanningAmounts: array Planning Amounts Title:
Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts. - PlanningEndDate: string (date-time) Title:
Planning Dates: To Date
The date that is planned on the financial plan for a resource to begin their assignment on a project task. - PlanningStartDate: string (date-time) Title:
Planning Dates: From Date
The date that is planned on the financial plan for a resource to finish their assignment on a project task.
Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
Show Source Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-item-patch-request
Type:
Show Source object
- Currency: string Maximum Length:
15
Code that identifies the planning currency on the forecast version resource assignment. - EACBurdenedCost: number Title:
Burdened Cost
Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACQuantity: number Title:
Quantity: EAC
Measure of the effort planned for in the forecast version resource assignment. - EACRawCost: number Title:
Raw Cost
Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. - EACRevenue: number Title:
Revenue: EAC
Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. - EffectiveETCBurdenedCostRate: number Title:
Burdened Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. - EffectiveETCRawCostRate: number Title:
Effective ETC Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. - EffectiveETCRevenueRate: number Title:
Revenue: Effective Rate
Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. - ManualSpreadFlag: boolean Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. - PlanLinesDFF: array Plan Lines Descriptive Flexfields Title:
Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts. - PlanningAmountDetails: array Planning Amount Details Title:
Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Nested Schema : Plan Lines Descriptive Flexfields
Type:
array
Title:
Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
Show Source Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Show Source Nested Schema : schema
Type:
Show Source object
- __FLEX_Context: string Title:
Context Segment
Maximum Length:30
Code that identifies the context for the segments of the plan lines flexfields. - __FLEX_Context_DisplayValue: string Title:
Context Segment
Name of the context for the segments of the plan lines flexfields.
Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-patch-request
Type:
Show Source object
- EACBurdenedCost: number Title:
Burdened Cost: EAC
Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACQuantity: number Title:
Quantity: EAC
Measure of the effort planned for in the forecast version resource assignment. - EACRawCost: number Title:
Raw Cost: EAC
Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. - EACRevenue: number Title:
Revenue
Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. - EffectiveETCBurdenedCostRate: number Title:
Burdened Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. - EffectiveETCRawCostRate: number Title:
Raw Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. - EffectiveETCRevenueRate: number Title:
Effective Revenue Rate
Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. - ManualSpreadFlag: boolean Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. - PeriodName: string Title:
Period
Maximum Length:30
Period for which the periodic forecast amount is entered.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
- Metadata-Context: If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectForecasts-PlanningResources-item-response
Type:
Show Source object
- links: array Links Title:
Links
The link relations associated with the resource instance. - MaintainManualSpreadOnDateChanges: string Default Value:
N
Indicates whether the periodic planning is retained in the plan version on plan line date modifications. - PlanningAmounts: array Planning Amounts Title:
Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts. - PlanningElementId: integer (int64) Title:
Planning Element ID
Identifier of the planning resources of the forecast version. - PlanningEndDate: string (date-time) Title:
Planning Dates: To Date
The date that is planned on the financial plan for a resource to begin their assignment on a project task. - PlanningStartDate: string (date-time) Title:
Planning Dates: From Date
The date that is planned on the financial plan for a resource to finish their assignment on a project task. - RbsElementId: integer (int64) Title:
Planning Resource
Identifier of the resource breakdown structure element used to create the financial plan resource assignment. - ResourceClass: string Title:
Resource Class
Read Only:true
Maximum Length:240
Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources. - ResourceName: string Title:
Resource
Maximum Length:240
Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment. - TaskId: integer (int64) Title:
Task
Identifier of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment. - TaskName: string Title:
Task Name
Maximum Length:255
Name of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task ID, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment. - TaskNumber: string Title:
Task Number
Maximum Length:100
Number of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task ID but not for all three or a combination of them while creating a financial plan resource assignment. - UnitOfMeasure: string Title:
Unit of Measure
Read Only:true
Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
Show Source Nested Schema : link
Type:
Show Source object
- href: string Title:
hyperlink reference
The URI to the related resource. - kind: string Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. - name: string Title:
name
The name of the link to the related resource. - properties: object properties
- rel: string Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object
- changeIndicator: string Change indicator or the ETag value of the resource instance.
Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-item-response
Type:
Show Source object
- ActualBurdenedCost: number Title:
Actual Burdened Cost
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date. - ActualBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date. - ActualBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date. - ActualBurdenedCostRate: number Title:
Burdened Cost Rate
Read Only:true
Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. - ActualQuantity: number Title:
Actual Quantity
Read Only:true
Actual effort for the forecast version resource assignment from the start of the project till the current date. - ActualRawCost: number Title:
Actual Raw Cost
Read Only:true
Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostRate: number Read Only:
true
Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed. - ActualRevenue: number Title:
Revenue: Actual Amount
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date. - ActualRevenueInProjectCurrency: number Title:
Revenue in Project Currency: Actual Amounts
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date. - ActualRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: Actual Amount
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date. - ActualRevenueRate: number Title:
Actual Rate
Read Only:true
Rate that is used to calculate the actual revenue for the forecast version resource assignment. - Currency: string Maximum Length:
15
Code that identifies the planning currency on the forecast version resource assignment. - EACBurdenedCost: number Title:
Burdened Cost
Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: EAC
Read Only:true
Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: EAC
Read Only:true
Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostRate: number Title:
Burdened Cost: Total Burdened Cost Rate
Read Only:true
Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. - EACQuantity: number Title:
Quantity: EAC
Measure of the effort planned for in the forecast version resource assignment. - EACRawCost: number Title:
Raw Cost
Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: EAC
Read Only:true
Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: EAC
Read Only:true
Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostRate: number Title:
Raw Cost: Total Raw Cost Rate
Read Only:true
Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRevenue: number Title:
Revenue: EAC
Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueInProjectCurrency: number Title:
Revenue in Project Currency: EAC
Read Only:true
Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: EAC
Read Only:true
Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueRate: number Title:
Effective Rate
Read Only:true
Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment. - EffectiveETCBurdenedCostRate: number Title:
Burdened Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. - EffectiveETCRawCostRate: number Title:
Effective ETC Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. - EffectiveETCRevenueRate: number Title:
Revenue: Effective Rate
Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. - ETCBurdenedCost: number Title:
ETC Burdened Cost
Read Only:true
Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: ETC
Read Only:true
Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: ETC
Read Only:true
Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCQuantity: number Title:
Quantity: ETC
Read Only:true
Estimated remaining effort by the forecast version resource assignment for completion. - ETCRawCost: number Title:
ETC Raw Cost
Read Only:true
Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed. - ETCRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: ETC
Read Only:true
Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. - ETCRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: ETC
Read Only:true
Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. - ETCRevenue: number Title:
Revenue: ETC
Read Only:true
Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. - ETCRevenueInProjectCurrency: number Title:
Revenue in Project Currency: ETC
Read Only:true
Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. - ETCRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: ETC
Read Only:true
Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. - links: array Links Title:
Links
The link relations associated with the resource instance. - ManualSpreadFlag: boolean Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. - PlanLineId: integer (int64) Title:
Plan Line ID
Identifier of the summary level planning amounts for a resource assignment in the forecast version. - PlanLinesDFF: array Plan Lines Descriptive Flexfields Title:
Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts. - PlanningAmountDetails: array Planning Amount Details Title:
Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts. - PurchaseOrderCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs. - PurchaseOrderCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs. - PurchaseOrderCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs. - PurchaseOrderCommittedQuantity: number Title:
Quantity Commitments: Purchase Orders
Read Only:true
Effort for the forecast version resource assignment committed through purchase orders. - PurchaseOrderCommittedRawCost: number Title:
Raw Cost Commitments: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed. - PurchaseOrderCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed. - PurchaseOrderCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed. - RequisitionCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs. - RequisitionCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs. - RequisitionCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs. - RequisitionCommittedQuantity: number Title:
Requisitions
Read Only:true
Effort for the forecast version resource assignment committed through requisitions. - RequisitionCommittedRawCost: number Title:
Raw Cost Commitments: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed. - RequisitionCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed. - RequisitionCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed. - StandardETCBurdenedCostRate: number Title:
Standard Burdened Cost Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. - StandardETCRawCostRate: number Title:
Standard ETC Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. - StandardETCRevenueRate: number Title:
Revenue: Standard Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. - SupplierInvoiceCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs. - SupplierInvoiceCommittedBurdenedCostinProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs. - SupplierInvoiceCommittedBurdenedCostinProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs. - SupplierInvoiceCommittedQuantity: number Title:
Quantity Commitments: Supplier Invoices
Read Only:true
Effort for the forecast version resource assignment committed through supplier invoices. - SupplierInvoiceCommittedRawCost: number Title:
Raw Cost Commitments: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed. - SupplierInvoiceCommittedRawCostinProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed. - SupplierInvoiceCommittedRawCostinProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed. - TotalCommittedBurdenedCost: number Title:
Burdened Cost: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs. - TotalCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs. - TotalCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. - TotalCommittedQuantity: number Title:
Quantity: Total Commitments
Read Only:true
Committed effort for the forecast version resource assignment. - TotalCommittedRawCost: number Title:
Raw Cost: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed. - TotalCommittedRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed. - TotalCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed. - TransferOrderCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs. - TransferOrderCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs. - TransferOrderCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs. - TransferOrderCommittedQuantity: number Title:
Quantity Commitments: Transfer Orders
Read Only:true
Effort for the forecast version resource assignment committed through transfer orders. - TransferOrderCommittedRawCost: number Title:
Raw Cost Commitments: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed. - TransferOrderCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed. - TransferOrderCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Plan Lines Descriptive Flexfields
Type:
array
Title:
Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
Show Source Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Show Source Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response
Type:
Show Source object
- __FLEX_Context: string Title:
Context Segment
Maximum Length:30
Code that identifies the context for the segments of the plan lines flexfields. - __FLEX_Context_DisplayValue: string Title:
Context Segment
Name of the context for the segments of the plan lines flexfields. - links: array Links Title:
Links
The link relations associated with the resource instance. - PlanLineId: integer (int64) Identifier of the summary level planning amounts for a plan line in the project forecast.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source object
- ActualBurdenedCost: number Title:
Burdened Cost: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date. - ActualBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date. - ActualBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date. - ActualBurdenedCostRate: number Title:
Burdened Cost Rate
Read Only:true
Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. - ActualQuantity: number Title:
Quantity: Actual Amount
Read Only:true
Actual effort for the forecast version resource assignment from the start of the project till the current date. - ActualRawCost: number Title:
Raw Cost: Actual Amount
Read Only:true
Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: Actual Amounts
Read Only:true
Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date. - ActualRawCostRate: number Title:
EAC Actual Raw Cost Rate
Read Only:true
Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed. - ActualRevenue: number Title:
Revenue: Actual Amount
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date. - ActualRevenueInProjectCurrency: number Title:
Revenue in Project Currency: Actual Amounts
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date. - ActualRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: Actual Amounts
Read Only:true
Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date. - ActualRevenueRate: number Title:
Revenue Rate: Actual Amount
Read Only:true
Rate that is used to calculate the actual revenue for the forecast version resource assignment. - EACBurdenedCost: number Title:
Burdened Cost: EAC
Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: EAC
Read Only:true
Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: EAC
Read Only:true
Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. - EACBurdenedCostRate: number Title:
Burdened Cost: Total Burdened Cost Rate
Read Only:true
Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. - EACQuantity: number Title:
Quantity: EAC
Measure of the effort planned for in the forecast version resource assignment. - EACRawCost: number Title:
Raw Cost: EAC
Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: EAC
Read Only:true
Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: EAC
Read Only:true
Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRawCostRate: number Title:
Raw Cost: Total Raw Cost Rate
Read Only:true
Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. - EACRevenue: number Title:
Revenue
Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueInProjectCurrency: number Title:
Revenue in Project Ledger Currency: EAC
Read Only:true
Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: EAC
Read Only:true
Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. - EACRevenueRate: number Title:
Revenue Rate
Read Only:true
Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment. - EffectiveETCBurdenedCostRate: number Title:
Burdened Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. - EffectiveETCRawCostRate: number Title:
Raw Cost: Effective Rate
Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. - EffectiveETCRevenueRate: number Title:
Effective Revenue Rate
Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. - ETCBurdenedCost: number Title:
Burdened Cost: ETC
Read Only:true
Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: ETC
Read Only:true
Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: ETC
Read Only:true
Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. - ETCQuantity: number Title:
Quantity: ETC
Read Only:true
Estimated remaining effort by the forecast version resource assignment for completion. - ETCRawCost: number Title:
Raw Cost: ETC
Read Only:true
Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed. - ETCRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: ETC
Read Only:true
Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. - ETCRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: ETC
Read Only:true
Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. - ETCRevenue: number Title:
Revenue: ETC
Read Only:true
Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. - ETCRevenueInProjectCurrency: number Title:
Previous Forecast Revenue in Project Currency: ETC
Read Only:true
Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. - ETCRevenueInProjectLedgerCurrency: number Title:
Revenue in Project Ledger Currency: ETC
Read Only:true
Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. - links: array Links Title:
Links
The link relations associated with the resource instance. - ManualSpreadFlag: boolean Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. - PeriodName: string Title:
Period
Maximum Length:30
Period for which the periodic forecast amount is entered. - PlanLineDetailId: integer (int64) Identifier of the periodic level planning amounts for a resource assignment in the forecast version.
- PurchaseOrderCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs. - PurchaseOrderCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs. - PurchaseOrderCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs. - PurchaseOrderCommittedQuantity: number Title:
Quantity Commitments: Purchase Orders
Read Only:true
Effort for the forecast version resource assignment committed through purchase orders. - PurchaseOrderCommittedRawCost: number Title:
Raw Cost Commitments: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed. - PurchaseOrderCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed. - PurchaseOrderCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Purchase Orders
Read Only:true
Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed. - RequisitionCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs. - RequisitionCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs. - RequisitionCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs. - RequisitionCommittedQuantity: number Title:
Quantity Commitments: Requisitions
Read Only:true
Effort for the forecast version resource assignment committed through requisitions. - RequisitionCommittedRawCost: number Title:
Raw Cost Commitments: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed. - RequisitionCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed. - RequisitionCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Requisitions
Read Only:true
Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed. - StandardETCBurdenedCostRate: number Title:
Burdened Cost: Standard Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. - StandardETCRawCostRate: number Title:
Raw Cost: Standard Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. - StandardETCRevenueRate: number Title:
Standard Revenue Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. - SupplierInvoiceCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs. - SupplierInvoiceCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs. - SupplierInvoiceCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs. - SupplierInvoiceCommittedQuantity: number Title:
Quantity Commitments: Supplier Invoices
Read Only:true
Effort for the forecast version resource assignment committed through supplier invoices. - SupplierInvoiceCommittedRawCost: number Title:
Raw Cost Commitments: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed. - SupplierInvoiceCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed. - SupplierInvoiceCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Supplier Invoices
Read Only:true
Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed. - TotalCommittedBurdenedCost: number Title:
Burdened Cost: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs. - TotalCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost in Project Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs. - TotalCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost in Project Ledger Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. - TotalCommittedQuantity: number Title:
Quantity: Total Commitments
Read Only:true
Committed effort for the forecast version resource assignment. - TotalCommittedRawCost: number Title:
Raw Cost: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed. - TotalCommittedRawCostInProjectCurrency: number Title:
Raw Cost in Project Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed. - TotalCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost in Project Ledger Currency: Total Commitments
Read Only:true
Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed. - TransferOrderCommittedBurdenedCost: number Title:
Burdened Cost Commitments: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs. - TransferOrderCommittedBurdenedCostInProjectCurrency: number Title:
Burdened Cost Commitments in Project Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs. - TransferOrderCommittedBurdenedCostInProjectLedgerCurrency: number Title:
Burdened Cost Commitments in Project Ledger Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs. - TransferOrderCommittedQuantity: number Title:
Quantity Commitments: Transfer Orders
Read Only:true
Effort for the forecast version resource assignment committed through transfer orders. - TransferOrderCommittedRawCost: number Title:
Raw Cost Commitments: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed. - TransferOrderCommittedRawCostInProjectCurrency: number Title:
Raw Cost Commitments in Project Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed. - TransferOrderCommittedRawCostInProjectLedgerCurrency: number Title:
Raw Cost Commitments in Project Ledger Currency: Transfer Orders
Read Only:true
Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Links
- PlanningAmounts
- Parameters:
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
The Planning Amounts resource is used to view project forecast resource assignment summary amounts. - PlanVersionId:
Examples
The following example shows how to update a planning resource for a project forecast version by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectForecasts/10736/child/PlanningResources/499182
Request Body Example
The following shows an example of the request body in JSON format.
{ "PlanningStartDate": "2008-06-01"}
Response Body Example
The following shows an example of the response body in JSON format.
{ "PlanningElementId": 499182, "TaskId": 100000044514349, "TaskNumber": "8.2", "TaskName": "Project Post-Mortem", "RbsElementId": 100000042522489, "ResourceName": "Labor-Patel, Ravi", "UnitOfMeasure": "Hours", "ResourceClass": "Labor", "PlanningStartDate": "2008-06-01T00:00:00+00:00", "PlanningEndDate": "2009-06-30T00:00:00+00:00" }