Get a planning amount for a resource assignment
get
/fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Request
Path Parameters
-
PlanLineId(required): integer(int64)
Identifier of the summary level planning amounts for a resource assignment in the financial project plan.
-
PlanVersionId(required): number
Identifier of the financial project plan version.
-
PlanningElementId(required): integer(int64)
Identifier of the resource assignment on the financial project plan 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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(required):
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(required):
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 : financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response
Type:
Show Source
object
-
BaselineBurdenedCost: number
Title:
Baseline Burdened Cost
Read Only:true
Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency. -
BaselineBurdenedCostInProjectCurrency: number
Title:
Rolled-up Baseline Cost for Resource in Project Currency
Read Only:true
Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency. -
BaselineBurdenedCostInProjectLedgerCurrency: number
Title:
Baseline Burdened Cost
Read Only:true
Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version. -
BaselineCurrency: string
Title:
Baseline Currency
Read Only:true
Maximum Length:30
Currency of the rendered baseline amounts. -
BaselineQuantity: number
Title:
Baseline Quantity
Read Only:true
Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours. -
BaselineRawCost: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed. -
BaselineRawCostInProjectCurrency: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed. -
BaselineRawCostInProjectLedgerCurrency: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
BurdenedCost: number
Title:
Burdened Cost
Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs. -
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs. -
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency: Total
Read Only:true
Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs. -
Currency: string
Title:
Currency
Maximum Length:15
Code that identifies the planning currency on the financial project plan resource assignment. -
EffectiveBurdenedCostRate: number
Title:
Average Effective Burden Cost Rate
Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. -
ITDActualBurdenedCost: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date. -
ITDActualQuantity: number
Title:
ITD Actual Quantity
Read Only:true
Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours. -
ITDActualRawCost: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectCurrency: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectLedgerCurrency: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date. -
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 financial project plan. -
PlanLinesDFF: array
Plan Lines Descriptive Flexfields
Title:
Plan Lines Descriptive Flexfields
The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans. -
PlannedQuantity: number
Title:
Planned Quantity
Measure of the effort planned for in the financial project plan resource assignment, expressed in hours. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts. -
RawCost: number
Title:
Raw Cost
Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed. -
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency: Total
Read Only:true
Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed. -
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.
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, view, and update additional information for planning amounts in financial project plans.
Show Source
Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic 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 : financialProjectPlans-ResourceAssignments-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 financial project plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object
-
BurdenedCost: number
Title:
Planned Burdened Cost
Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs. -
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs. -
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency: Total
Read Only:true
Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost Rate
Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. -
EffectiveRawCostRate: number
Title:
Effective Rate
Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. -
ITDActualBurdenedCost: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date. -
ITDActualQuantity: number
Title:
ITD Actual Quantity
Read Only:true
Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours. -
ITDActualRawCost: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectCurrency: number
Title:
ITD Actual in Project Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date. -
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 level planning amounts are created for a resource assignment in the financial project plan. -
PlannedQuantity: number
Title:
Planned Quantity
Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours. -
RawCost: number
Title:
Raw cost
Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed. -
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency: Total
Read Only:true
Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed. -
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency: Total
Read Only:true
Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PlanLinesDFF
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans. - PlanLineId:
- PlanningAmountDetails
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts. - PlanLineId:
- adjust
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
Adjusts the financia project plan line using the adjustment parameters. - PlanLineId:
- refreshRates
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
Refreshes rates for the financial project plan line. - PlanLineId:
- updatePlannedAmountsFromProgress
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
Updates planned amounts from progress for a resource. - PlanLineId:
Examples
The following example shows how to get a planning amount for a resource assignment 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/financialProjectPlans/4067307/child/ResourceAssignments/1987603435/child/PlanningAmounts/27065059209
Response Body Example
The following shows an example of the response body in JSON format.
{ "PlanLineId": 27065059209, "PlannedQuantity": 3030, "ITDActualQuantity": null, "BaselineQuantity": null, "Currency": "USD", "RawCost": 6060, "ITDActualRawCost": null, "BaselineRawCost": null, "BurdenedCost": 9090, "ITDActualBurdenedCost": null, "BaselineBurdenedCost": null, "EffectiveRawCostRate": 2, "StandardRawCostRate": null, "EffectiveBurdenedCostRate": 3, "StandardBurdenedCostRate": null, "RawCostInProjectCurrency": 6060, "ITDActualRawCostInProjectCurrency": null, "BaselineRawCostInProjectCurrency": null, "BurdenedCostInProjectCurrency": 9090, "ITDActualBurdenedCostInProjectCurrency": null, "BaselineBurdenedCostInProjectCurrency": null, "RawCostInProjectLedgerCurrency": 6060, "ITDActualRawCostInProjectLedgerCurrency": null, "BaselineRawCostInProjectLedgerCurrency": null, "BurdenedCostInProjectLedgerCurrency": 9090, "ITDActualBurdenedCostInProjectLedgerCurrency": null, "BaselineBurdenedCostInProjectLedgerCurrency": null }