Create a planning resource for a project budget version
post
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the project budget 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.
-
Upsert-Mode: string
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-
MaintainManualSpreadOnDateChanges: string
Default Value:
NIndicates if the periodic planning is retained on plan line date modifications. -
PlanningAmounts: array
Planning Amounts
Title:
Planning AmountsThe Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line. -
PlanningElementId: integer
(int64)
Title:
Planning Element IDIdentifier of the project budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To DateThe finish date of the resource assignment on the task in the project budget version. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From DateThe start date of the resource assignment on the task in the project budget version. -
RbsElementId(required): integer
(int64)
Identifier of the resource which is assigned to a task on a project budget line.
-
ResourceName: string
Title:
Resource NameMaximum Length:240Name of the resource which is assigned to a task on a project budget line. -
TaskId(required): integer
(int64)
Identifier of the task to which a planning resource is assigned on a project budget line.
-
TaskName: string
Title:
Task NameMaximum Length:255Name of the task to which a planning resource is assigned on a project budget line. -
TaskNumber: string
Title:
Task NumberMaximum Length:100Number of the task to which a planning resource is assigned on a project budget line.
Nested Schema : Planning Amounts
Type:
arrayTitle:
Planning AmountsThe Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.
Show Source
Nested Schema : schema
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostBudget line burdened cost amounts in transaction currency. -
Currency(required): string
Maximum Length:
15Currency code for the budget lines. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective RateEffective burdened cost rate for budget line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost RateEffective raw cost rate for budget line. -
EffectiveRevenueRate: number
Title:
Effective Revenue RateEffective revenue rate for budget line. -
ManualSpreadFlag: boolean
Maximum Length:
1Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PlanLineId: integer
(int64)
Identifier of the planning amounts for a resource assignment in the project budget version.
-
PlanLinesDFF: array
Plan Lines Descriptive Flexfields
Title:
Plan Lines Descriptive FlexfieldsThe Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the budget line. -
RawCostAmounts: number
Title:
Raw CostBudget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenueBudget line revenue amounts in transaction currency.
Nested Schema : Plan Lines Descriptive Flexfields
Type:
arrayTitle:
Plan Lines Descriptive FlexfieldsThe Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
arrayTitle:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-post-request
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. -
PlanLineId: integer
(int64)
Identifier of the summary level planning amounts for a plan line in the project budget.
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-post-request
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostPeriodic budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective RateEffective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost RateEffective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Revenue RateEffective revenue rate for periodic line. -
ManualSpreadFlag: boolean
Maximum Length:
1Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PeriodName: string
Maximum Length:
30Period for which the periodic budget amount is entered. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details IDIdentifier of the periodic level planning amounts for a resource assignment in the project budget version. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the budget line by period. -
RawCostAmounts: number
Title:
Raw CostPeriodic budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenuePeriodic budget line revenue amounts in transaction currency.
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 : projectBudgets-PlanningResources-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaintainManualSpreadOnDateChanges: string
Default Value:
NIndicates if the periodic planning is retained on plan line date modifications. -
PlanningAmounts: array
Planning Amounts
Title:
Planning AmountsThe Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line. -
PlanningElementId: integer
(int64)
Title:
Planning Element IDIdentifier of the project budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To DateThe finish date of the resource assignment on the task in the project budget version. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From DateThe start date of the resource assignment on the task in the project budget version. -
RbsElementId: integer
(int64)
Identifier of the resource which is assigned to a task on a project budget line.
-
ResourceName: string
Title:
Resource NameMaximum Length:240Name of the resource which is assigned to a task on a project budget line. -
TaskId: integer
(int64)
Identifier of the task to which a planning resource is assigned on a project budget line.
-
TaskName: string
Title:
Task NameMaximum Length:255Name of the task to which a planning resource is assigned on a project budget line. -
TaskNumber: string
Title:
Task NumberMaximum Length:100Number of the task to which a planning resource is assigned on a project budget line. -
UnitOfMeasure: string
Read Only:
trueThe unit, such as Hours, that is used to measure the work or effort that is planned for a resource.
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, create, update, and delete periodic amounts for a budget line.
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 : projectBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostBudget line burdened cost amounts in transaction currency. -
Currency: string
Maximum Length:
15Currency code for the budget lines. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective RateEffective burdened cost rate for budget line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost RateEffective raw cost rate for budget line. -
EffectiveRevenueRate: number
Title:
Effective Revenue RateEffective revenue rate for budget line. -
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. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project CurrencyRead Only:trueBudget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project CurrencyRead Only:trueBudget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project CurrencyRead Only:trueBudget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger CurrencyRead Only:trueBudget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger CurrencyRead Only:trueBudget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger CurrencyRead Only:trueBudget line revenue amounts in project ledger currency. -
PlanLineId: integer
(int64)
Identifier of the planning amounts for a resource assignment in the project budget version.
-
PlanLinesDFF: array
Plan Lines Descriptive Flexfields
Title:
Plan Lines Descriptive FlexfieldsThe Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the budget line. -
RawCostAmounts: number
Title:
Raw CostBudget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenueBudget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost RateRead Only:trueStandard burdened cost rate for budget line. -
StandardRawCostRate: number
Title:
Standard Raw Cost RateRead Only:trueStandard raw cost rate for budget line. -
StandardRevenueRate: number
Title:
Standard Revenue RateRead Only:trueStandard revenue rate for budget line.
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, view, and update additional information for planning amounts in project budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
arrayTitle:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
Show Source
Nested Schema : projectBudgets-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 budget.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostPeriodic budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective RateEffective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost RateEffective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Revenue RateEffective revenue rate for periodic line. -
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. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project CurrencyRead Only:truePeriodic budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project CurrencyRead Only:truePeriodic budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project CurrencyRead Only:truePeriodic budget line revenue amounts in project currency. -
PeriodName: string
Maximum Length:
30Period for which the periodic budget amount is entered. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger CurrencyRead Only:truePeriodic budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger CurrencyRead Only:truePeriodic budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger CurrencyRead Only:truePeriodic budget line revenue amounts in project ledger currency. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details IDIdentifier of the periodic level planning amounts for a resource assignment in the project budget version. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the budget line by period. -
RawCostAmounts: number
Title:
Raw CostPeriodic budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenuePeriodic budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost RateRead Only:trueStandard burdened cost rate for periodic line. -
StandardRawCostRate: number
Title:
Standard Raw Cost RateRead Only:trueStandard raw cost rate for periodic line. -
StandardRevenueRate: number
Title:
Standard Revenue RateRead Only:trueStandard revenue rate for periodic line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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, create, update, and delete periodic amounts for a budget line. - PlanVersionId:
Examples
The following example shows how to create planning resource by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets
Example of Request Body
The following example shows the request body to create a new impact for a change order that is associated to the project with project ID 300100125163003.
{
"FinancialPlanType":"Estimate",
"PlanVersionDescription": "New Manual Version",
"BudgetCreationMethod": "MANUAL",
"PlanVersionStatus": "Current Working",
"ProjectName": "DEV_PJO_CDRM_R13MBV_CRSAME",
"PlanningResources": [
{
"TaskNumber": "1.1",
"ResourceName": "Labor",
"PlanningStartDate": "2017-01-01",
"PlanningEndDate": "2017-03-01",
"PlanningAmounts": [
{
"Currency": "USD",
"Quantity": 140
}
]
}, {
"TaskNumber": "2.0",
"ResourceName": "Financial Resources",
"PlanningStartDate": "2017-03-03",
"PlanningEndDate": "2017-06-02",
"PlanningAmounts": [
{
"Currency": "USD",
"RawCostAmounts": 150
}
]
},
{
"TaskNumber": "3.2",
"ResourceName": "Marlin, Ms. Amy",
"PlanningAmounts": [
{
"Currency": "USD",
"PlanningAmountDetails": [
{
"PeriodName": "May-17",
"Quantity": 100,
"RawCostAmounts": 1500,
"BurdenedCostAmounts": 2000,
"RevenueAmounts": 3000
}
]
}
]
}
]
}Example of Response Body
The following shows an example of the response body in JSON format.
{
"FinancialPlanType": "Estimate",
"PlanningAmounts": "COST_AND_REV_TOGETHER",
"PlanVersionId": 300100152060530,
"PlanVersionNumber": 1,
"PlanVersionName": "Version 1",
"PlanVersionDescription": "New Manual Version",
"PlanVersionStatus": "Current Working",
"ProjectId": 300100084467409,
"ProjectNumber": "DEV_PJO_CDRM_R13MBV_CRSAM",
"ProjectName": "DEV_PJO_CDRM_R13MBV_CRSAME",
"BudgetCreationMethod": "MANUAL",
"SourcePlanVersionId": null,
"BudgetGenerationSource": null,
"SourcePlanType": null,
"SourcePlanVersionStatus": null,
"SourcePlanVersionNumber": null,
"CopyAdjustmentPercentage": null,
"PCRawCostAmounts": null,
"PCBurdenedCostAmounts": null,
"PCRevenueAmounts": null,
"PFCRawCostAmounts": null,
"PFCBurdenedCostAmounts": null,
"PFCRevenueAmounts": null,
"DeferFinancialPlanCreation": "Y",
"AdministrativeCode": null,
"PlanningResources": [
{
"TaskId": 100100048825141,
"TaskNumber": "1.1",
"TaskName": "Review Data Perform Field Investigations and Testing",
"RbsElementId": 100100048825129,
"ResourceName": "Labor",
"PlanningStartDate": "2017-01-01T00:00:00+00:00",
"PlanningEndDate": "2017-03-01T00:00:00+00:00",
"PlanningAmounts": [
{
"Quantity": 140,
"Currency": "USD",
"RawCostAmounts": null,
"BurdenedCostAmounts": null,
"RevenueAmounts": null,
"EffectiveRawCostRate": null,
"StandardRawCostRate": null,
"EffectiveBurdenedCostRate": null,
"StandardBurdenedCostRate": null,
"EffectiveRevenueRate": null,
"StandardRevenueRate": null,
"PCRawCostAmounts": null,
"PCBurdenedCostAmounts": null,
"PCRevenueAmounts": null,
"PFCRawCostAmounts": null,
"PFCBurdenedCostAmounts": null,
"PFCRevenueAmounts": null
}
]
}
}