Create a planning resource for an award budget version
post
/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the award budget 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-
FundingSourceId: integer
(int64)
Identifier of the funding source used to create the award budget line.
-
FundingSourceName: string
Title:
Funding Source NameMaximum Length:360Funding Source Name used to create the award budget line. -
FundingSourceNumber: string
Title:
Funding Source NumberMaximum Length:50Funding Source Number used to create the award budget line. -
PlanningAmounts: array
Planning Amounts
Title:
Planning AmountsThe Planning Amounts resource is used to view, create, and delete an award budget line amounts. -
PlanningElementId: integer
(int64)
Title:
Planning Element IDIdentifier of the award budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To DateAward budget line end date. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From DateAward budget line start date. -
RbsElementId(required): integer
(int64)
Identifier of the resource used to create the award budget line.
-
ResourceName: string
Title:
Resource NameMaximum Length:240The name of the resource used to create the award budget line. -
TaskId(required): integer
(int64)
Identifier of the task which is used to create a award budget line.
-
TaskName(required): string
Title:
Task NameMaximum Length:255Name of the task which is used to create a award budget line. -
TaskNumber: string
Title:
Task NumberMaximum Length:100Number of the task which is used to create a award budget line.
Nested Schema : Planning Amounts
Type:
arrayTitle:
Planning AmountsThe Planning Amounts resource is used to view, create, and delete an award budget line amounts.
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-item-post-request
Type:
Show Source
object-
Currency(required): string
Maximum Length:
15Currency code for the award budget lines. -
PlanLineId: integer
(int64)
Title:
Plan Line IDIdentifier of the award budget line amounts. -
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 award budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.
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 award budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
arrayTitle:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.
Show Source
Nested Schema : awardBudgets-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 award budget.
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-post-request
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostPeriodic award 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. -
PeriodName: string
Maximum Length:
30Period for which the periodic budget amount is entered. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details IDIdentifier of the award budget periodic amounts. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the award budget line by period. -
RawCostAmounts: number
Title:
Raw CostPeriodic award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenuePeriodic award 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 : awardBudgets-PlanningResources-item-response
Type:
Show Source
object-
FundingSourceId: integer
(int64)
Identifier of the funding source used to create the award budget line.
-
FundingSourceName: string
Title:
Funding Source NameMaximum Length:360Funding Source Name used to create the award budget line. -
FundingSourceNumber: string
Title:
Funding Source NumberMaximum Length:50Funding Source Number used to create the award budget line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PlanningAmounts: array
Planning Amounts
Title:
Planning AmountsThe Planning Amounts resource is used to view, create, and delete an award budget line amounts. -
PlanningElementId: integer
(int64)
Title:
Planning Element IDIdentifier of the award budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To DateAward budget line end date. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From DateAward budget line start date. -
RbsElementId: integer
(int64)
Identifier of the resource used to create the award budget line.
-
ResourceName: string
Title:
Resource NameMaximum Length:240The name of the resource used to create the award budget line. -
TaskId: integer
(int64)
Identifier of the task which is used to create a award budget line.
-
TaskName: string
Title:
Task NameMaximum Length:255Name of the task which is used to create a award budget line. -
TaskNumber: string
Title:
Task NumberMaximum Length:100Number of the task which is used to create a award budget line. -
UnitOfMeasure: string
Read Only:
trueThe units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line.
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, and delete an award budget line 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 : awardBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostRead Only:trueAward budget line burdened cost amounts in transaction currency. -
Currency: string
Maximum Length:
15Currency code for the award budget lines. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective RateRead Only:trueEffective burdened cost rate for award budget line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost RateRead Only:trueEffective raw cost rate for award budget line. -
EffectiveRevenueRate: number
Title:
Effective Revenue RateRead Only:trueEffective revenue rate for award budget line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project CurrencyRead Only:trueAward budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project CurrencyRead Only:trueAward budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project CurrencyRead Only:trueAward budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger CurrencyRead Only:trueAward budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger CurrencyRead Only:trueAward budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger CurrencyRead Only:trueAward budget line revenue amounts in project ledger currency. -
PlanLineId: integer
(int64)
Title:
Plan Line IDIdentifier of the award budget line amounts. -
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 award budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts. -
Quantity: number
Title:
QuantityRead Only:trueMeasure of the effort planned for the award budget line. -
RawCostAmounts: number
Title:
Raw CostRead Only:trueAward budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenueRead Only:trueAward budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost RateRead Only:trueStandard burdened cost rate for award budget line. -
StandardRawCostRate: number
Title:
Standard Raw Cost RateRead Only:trueStandard raw cost rate for award budget line. -
StandardRevenueRate: number
Title:
Standard Revenue RateRead Only:trueStandard revenue rate for award 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 award budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
arrayTitle:
Planning Amount DetailsThe Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.
Show Source
Nested Schema : awardBudgets-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 award budget.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object-
BurdenedCostAmounts: number
Title:
Burdened CostPeriodic award 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. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project CurrencyRead Only:truePeriodic award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project CurrencyRead Only:truePeriodic award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project CurrencyRead Only:truePeriodic award 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 award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger CurrencyRead Only:truePeriodic award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger CurrencyRead Only:truePeriodic award budget line revenue amounts in project ledger currency. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details IDIdentifier of the award budget periodic amounts. -
Quantity: number
Title:
QuantityMeasure of the effort planned for the award budget line by period. -
RawCostAmounts: number
Title:
Raw CostPeriodic award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
RevenuePeriodic award 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, and delete an award budget line amounts. - PlanVersionId:
Examples
The following example shows how to create a planning resource for an award budget version 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/awardBudgets/300100185480772/child/PlanningResources
Request Body Example
The following shows an example of the request body in JSON format.
{
"TaskNumber":"PRE_REL13_RES_A2_P1",
"ResourceName":"Salary",
"FundingSourceName": "Dept of Health and Human Services (DHHS)",
"PlanningAmounts":[
{
"Currency":"USD",
"PlanningAmountDetails":[
{
"PeriodName":"YrStartOct-14",
"Quantity":100
}
]
}
]
}Response Body Example
The following shows an example of the response body in JSON format.
{
"PlanningElementId": 300100185480786,
"TaskId": 300100101030540,
"TaskNumber": "PRE_REL13_RES_A2_P1",
"TaskName": "PRE_REL13_RES_A2_P1",
"RbsElementId": 300100038787345,
"ResourceName": "Salary",
"UnitOfMeasure": "HOURS",
"PlanningStartDate": "2013-10-01T00:00:00+00:00",
"PlanningEndDate": "2018-10-30T00:00:00+00:00",
"FundingSourceId": 300100038787369,
"FundingSourceNumber": "CDRM_70255",
"FundingSourceName": "Dept of Health and Human Services (DHHS)",
"PlanningAmounts": {
"items": [
{
"PlanLineId": 300100185480787,
"Quantity": null,
"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,
"PlanningAmountDetails": {
"items": [
{
"PlanLineDetailId": 300100185480788,
"PeriodName": "YrStartOct-14",
"Quantity": 100,
"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,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787/child/PlanningAmountDetails/300100185480788",
"name": "PlanningAmountDetails",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787/child/PlanningAmountDetails/300100185480788",
"name": "PlanningAmountDetails",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787",
"name": "PlanningAmounts",
"kind": "item"
}
],
}
],
"count": 1,
"hasMore": false,
"limit": 24,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787/child/PlanningAmountDetails",
"name": "PlanningAmountDetails",
"kind": "collection"
}
],
},
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787",
"name": "PlanningAmounts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787",
"name": "PlanningAmounts",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786",
"name": "PlanningResources",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787/child/PlanLinesDFF",
"name": "PlanLinesDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts/300100185480787/child/PlanningAmountDetails",
"name": "PlanningAmountDetails",
"kind": "collection"
}
],
}
],
"count": 1,
"hasMore": false,
"limit": 24,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts",
"name": "PlanningAmounts",
"kind": "collection"
}
],
},
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786",
"name": "PlanningResources",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786",
"name": "PlanningResources",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772",
"name": "awardBudgets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/lov/PrimaryPlanningRBSLOVVO",
"name": "PrimaryPlanningRBSLOVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/lov/FinancialTaskVersionLOVVO",
"name": "FinancialTaskVersionLOVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/lov/ProjectAwardFundingSourceLOVVO",
"name": "ProjectAwardFundingSourceLOVVO",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185480772/child/PlanningResources/300100185480786/child/PlanningAmounts",
"name": "PlanningAmounts",
"kind": "collection"
}
],
}