Create a periodic planning amount for a resource assignment
post
/fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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.
Response
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-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
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.
Links
- adjust
-
Parameters:
- PlanLineId:
$request.path.PlanLineId
- PlanVersionId:
$request.path.PlanVersionId
- PlanningAmountDetailsUniqID:
$request.path.PlanningAmountDetailsUniqID
- PlanningElementId:
$request.path.PlanningElementId
Adjusts the financial project plan line period using the adjustment parameters. - PlanLineId: