Get all planning resources for a project forecast version
get
/fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the forecast version.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all project forecast resource assignments with the specified resource assignment ID.
Finder Variables:- PlanningElementId; integer; Identifier of the resource assignment for a forecast version.
- PrimaryKey: Finds all project forecast resource assignments with the specified resource assignment ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- PlanningElementId; integer; Identifier of the planning resources of the forecast version.
- PlanningEndDate; string; The date that is planned on the financial plan for a resource to begin their assignment on a project task.
- PlanningStartDate; string; The date that is planned on the financial plan for a resource to finish their assignment on a project task.
- RbsElementId; integer; Identifier of the resource breakdown structure element used to create the financial plan resource assignment.
- ResourceClass; string; 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; 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; 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; 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; 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; Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectForecasts-PlanningResources-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaintainManualSpreadOnDateChanges: string
Default Value:
NIndicates whether the periodic planning is retained in the plan version on plan line date modifications. -
PlanningAmounts: array
Planning Amounts
Title:
Planning AmountsThe Planning Amounts resource is used to view project forecast resource assignment summary amounts. -
PlanningElementId: integer
(int64)
Title:
Planning Element IDIdentifier of the planning resources of the forecast version. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To DateThe 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 DateThe date that is planned on the financial plan for a resource to finish their assignment on a project task. -
RbsElementId: integer
(int64)
Title:
Planning ResourceIdentifier of the resource breakdown structure element used to create the financial plan resource assignment. -
ResourceClass: string
Title:
Resource ClassRead Only:trueMaximum Length:240Grouping 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:
ResourceMaximum Length:240Name 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:
TaskIdentifier 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 NameMaximum Length:255Name 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 NumberMaximum Length:100Number 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 MeasureRead Only:trueUnit 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Planning Amounts
Type:
arrayTitle:
Planning AmountsThe 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 CostRead Only:trueActual 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 AmountsRead Only:trueActual 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 AmountsRead Only:trueActual 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 RateRead Only:trueActual 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 QuantityRead Only:trueActual effort for the forecast version resource assignment from the start of the project till the current date. -
ActualRawCost: number
Title:
Actual Raw CostRead Only:trueActual 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 AmountsRead Only:trueActual 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 AmountsRead Only:trueActual 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:
trueRate 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 AmountRead Only:trueAmount 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 AmountsRead Only:trueAmount 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 AmountRead Only:trueAmount 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 RateRead Only:trueRate that is used to calculate the actual revenue for the forecast version resource assignment. -
Currency: string
Maximum Length:
15Code that identifies the planning currency on the forecast version resource assignment. -
EACBurdenedCost: number
Title:
Burdened CostEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated 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 RateRead Only:trueRate 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: EACMeasure of the effort planned for in the forecast version resource assignment. -
EACRawCost: number
Title:
Raw CostEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated 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 RateRead Only:trueRate 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: EACEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. -
EACRevenueRate: number
Title:
Effective RateRead Only:trueRate 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 RateCost 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 RateCost 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 RateRevenue 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 CostRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated remaining effort by the forecast version resource assignment for completion. -
ETCRawCost: number
Title:
ETC Raw CostRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. -
ETCRevenueInProjectCurrency: number
Title:
Revenue in Project Currency: ETCRead Only:trueEstimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. -
ETCRevenueInProjectLedgerCurrency: number
Title:
Revenue in Project Ledger Currency: ETCRead Only:trueEstimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PlanLineId: integer
(int64)
Title:
Plan Line IDIdentifier of the summary level planning amounts for a resource assignment in the forecast version. -
PlanLinesDFF: array
Plan Lines Descriptive Flexfields
Title:
Plan Lines Descriptive FlexfieldsThe 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 DetailsThe Planning Amount Details resource is used to view project forecast resource assignment periodic amounts. -
PurchaseOrderCommittedBurdenedCost: number
Title:
Burdened Cost Commitments: Purchase OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueEffort for the forecast version resource assignment committed through purchase orders. -
PurchaseOrderCommittedRawCost: number
Title:
Raw Cost Commitments: Purchase OrdersRead Only:trueCost 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 InvoicesRead Only:trueCost 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 OrdersRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs. -
RequisitionCommittedQuantity: number
Title:
RequisitionsRead Only:trueEffort for the forecast version resource assignment committed through requisitions. -
RequisitionCommittedRawCost: number
Title:
Raw Cost Commitments: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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 RateRead Only:trueAverage rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. -
StandardETCRawCostRate: number
Title:
Standard ETC RateRead Only:trueRate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. -
StandardETCRevenueRate: number
Title:
Revenue: Standard RateRead Only:trueRate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. -
SupplierInvoiceCommittedBurdenedCost: number
Title:
Burdened Cost Commitments: Supplier InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueEffort for the forecast version resource assignment committed through supplier invoices. -
SupplierInvoiceCommittedRawCost: number
Title:
Raw Cost Commitments: Supplier InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. -
TotalCommittedQuantity: number
Title:
Quantity: Total CommitmentsRead Only:trueCommitted effort for the forecast version resource assignment. -
TotalCommittedRawCost: number
Title:
Raw Cost: Total CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueEffort for the forecast version resource assignment committed through transfer orders. -
TransferOrderCommittedRawCost: number
Title:
Raw Cost Commitments: Transfer OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Plan Lines Descriptive Flexfields
Type:
arrayTitle:
Plan Lines Descriptive FlexfieldsThe 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:
arrayTitle:
Planning Amount DetailsThe 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 SegmentMaximum Length:30Code that identifies the context for the segments of the plan lines flexfields. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentName of the context for the segments of the plan lines flexfields. -
links: array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe 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 AmountsRead Only:trueActual 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 AmountsRead Only:trueActual 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 AmountsRead Only:trueActual 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 RateRead Only:trueActual 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 AmountRead Only:trueActual effort for the forecast version resource assignment from the start of the project till the current date. -
ActualRawCost: number
Title:
Raw Cost: Actual AmountRead Only:trueActual 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 AmountsRead Only:trueActual 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 AmountsRead Only:trueActual 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 RateRead Only:trueRate 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 AmountRead Only:trueAmount 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 AmountsRead Only:trueAmount 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 AmountsRead Only:trueAmount 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 AmountRead Only:trueRate that is used to calculate the actual revenue for the forecast version resource assignment. -
EACBurdenedCost: number
Title:
Burdened Cost: EACEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated 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 RateRead Only:trueRate 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: EACMeasure of the effort planned for in the forecast version resource assignment. -
EACRawCost: number
Title:
Raw Cost: EACEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated 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 RateRead Only:trueRate 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:
RevenueEstimated 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: EACRead Only:trueEstimated 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: EACRead Only:trueEstimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. -
EACRevenueRate: number
Title:
Revenue RateRead Only:trueRate 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 RateCost 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 RateCost 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 RateRevenue 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated remaining effort by the forecast version resource assignment for completion. -
ETCRawCost: number
Title:
Raw Cost: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated 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: ETCRead Only:trueEstimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. -
ETCRevenueInProjectCurrency: number
Title:
Previous Forecast Revenue in Project Currency: ETCRead Only:trueEstimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. -
ETCRevenueInProjectLedgerCurrency: number
Title:
Revenue in Project Ledger Currency: ETCRead Only:trueEstimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PeriodName: string
Title:
PeriodMaximum Length:30Period 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueEffort for the forecast version resource assignment committed through purchase orders. -
PurchaseOrderCommittedRawCost: number
Title:
Raw Cost Commitments: Purchase OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueEffort for the forecast version resource assignment committed through requisitions. -
RequisitionCommittedRawCost: number
Title:
Raw Cost Commitments: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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: RequisitionsRead Only:trueCost 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 RateRead Only:trueAverage rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. -
StandardETCRawCostRate: number
Title:
Raw Cost: Standard RateRead Only:trueRate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. -
StandardETCRevenueRate: number
Title:
Standard Revenue RateRead Only:trueRate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. -
SupplierInvoiceCommittedBurdenedCost: number
Title:
Burdened Cost Commitments: Supplier InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueEffort for the forecast version resource assignment committed through supplier invoices. -
SupplierInvoiceCommittedRawCost: number
Title:
Raw Cost Commitments: Supplier InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 InvoicesRead Only:trueCost 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. -
TotalCommittedQuantity: number
Title:
Quantity: Total CommitmentsRead Only:trueCommitted effort for the forecast version resource assignment. -
TotalCommittedRawCost: number
Title:
Raw Cost: Total CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 CommitmentsRead Only:trueTotal 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueEffort for the forecast version resource assignment committed through transfer orders. -
TransferOrderCommittedRawCost: number
Title:
Raw Cost Commitments: Transfer OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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 OrdersRead Only:trueCost 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all project forecast lines for a project forecast version by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectForecasts/10736/child/PlanningResources
Response Body Example
The following shows an example of the response body in JSON format.
{
"items": [
{
"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"
}