Update a planning resource for an award budget version
patch
/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the award budget version.
-
PlanningElementId(required): integer(int64)
Identifier of the award budget line.
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.
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 Name
Maximum Length:360
Funding Source Name used to create the award budget line. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding Source Number used to create the award budget line. -
PlanningAmounts: array
Planning Amounts
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, and delete an award budget line amounts.
Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, and delete an award budget line amounts.
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-item-patch-request
Type:
Show Source
object
Nested Schema : schema
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.
Nested Schema : schema
Type:
Show Source
object
-
BurdenedCostAmounts: number
Title:
Burdened Cost
Periodic award budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective Rate
Effective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Effective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Revenue Rate
Effective revenue rate for periodic line. -
Quantity: number
Title:
Quantity
Measure of the effort planned for the award budget line by period. -
RawCostAmounts: number
Title:
Raw Cost
Periodic award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
Revenue
Periodic 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(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 : 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 Name
Maximum Length:360
Funding Source Name used to create the award budget line. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding Source Number used to create the award budget line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningAmounts: array
Planning Amounts
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, and delete an award budget line amounts. -
PlanningElementId: integer
(int64)
Title:
Planning Element ID
Identifier of the award budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To Date
Award budget line end date. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From Date
Award budget line start date. -
RbsElementId: integer
(int64)
Identifier of the resource used to create the award budget line.
-
ResourceName: string
Title:
Resource Name
Maximum Length:240
The 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 Name
Maximum Length:255
Name of the task which is used to create a award budget line. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Number of the task which is used to create a award budget line. -
UnitOfMeasure: string
Read Only:
true
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The 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 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 : awardBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source
object
-
BurdenedCostAmounts: number
Title:
Burdened Cost
Read Only:true
Award budget line burdened cost amounts in transaction currency. -
Currency: string
Maximum Length:
15
Currency code for the award budget lines. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective Rate
Read Only:true
Effective burdened cost rate for award budget line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Read Only:true
Effective raw cost rate for award budget line. -
EffectiveRevenueRate: number
Title:
Effective Revenue Rate
Read Only:true
Effective revenue rate for award budget line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Currency
Read Only:true
Award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project Currency
Read Only:true
Award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project Currency
Read Only:true
Award budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger Currency
Read Only:true
Award budget line revenue amounts in project ledger currency. -
PlanLineId: integer
(int64)
Title:
Plan Line ID
Identifier of the award budget line amounts. -
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 award budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts. -
Quantity: number
Title:
Quantity
Read Only:true
Measure of the effort planned for the award budget line. -
RawCostAmounts: number
Title:
Raw Cost
Read Only:true
Award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
Revenue
Read Only:true
Award budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Standard burdened cost rate for award budget line. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Standard raw cost rate for award budget line. -
StandardRevenueRate: number
Title:
Standard Revenue Rate
Read Only:true
Standard revenue rate for award budget line.
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 award budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The 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 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 award budget.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Cost
Periodic award budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective Rate
Effective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Effective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Revenue Rate
Effective revenue rate for periodic line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Currency
Read Only:true
Periodic award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project Currency
Read Only:true
Periodic award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project Currency
Read Only:true
Periodic award budget line revenue amounts in project currency. -
PeriodName: string
Maximum Length:
30
Period for which the periodic budget amount is entered. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Periodic award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Periodic award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger Currency
Read Only:true
Periodic award budget line revenue amounts in project ledger currency. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details ID
Identifier of the award budget periodic amounts. -
Quantity: number
Title:
Quantity
Measure of the effort planned for the award budget line by period. -
RawCostAmounts: number
Title:
Raw Cost
Periodic award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
Revenue
Periodic award budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Standard burdened cost rate for periodic line. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Standard raw cost rate for periodic line. -
StandardRevenueRate: number
Title:
Standard Revenue Rate
Read Only:true
Standard revenue rate for periodic line.
Nested Schema : Links
Type:
array
Title:
Links
The 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 update a planning resource for an award budget version by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100151593859
Request Body Example
The following shows an example of the request body in JSON format.
{ "TaskNumber":"1", "ResourceName":"Labor", "FundingSourceNumber":"CDRM_70255", "PlanningAmounts":[ { "Currency":"USD", "PlanningAmountDetails":[ { "PeriodName":"P1", "Quantity":15 } ] } ] }
Response Body Example
The following shows an example of the response body in JSON format.
{ "TaskId" : 300100095525318, "TaskNumber" : "PJO_Award_PRJ1", "TaskName" : "PJO_Award_PRJ1", "RbsElementId" : 300100038787339, "ResourceName" : "Labor", "UnitOfMeasure" : "DOLLARS", "PlanningStartDate" : "2013-09-01T00:00:00+00:00", "PlanningEndDate" : "2018-11-29T00:00:00+00:00", "FundingSourceId" : 300100038787369, "FundingSourceNumber" : "CDRM_70255", "FundingSourceName" : "Dept of Health and Human Services (DHHS)", "PlanningAmounts" : [ { "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" : [ { "PeriodName" : "P3", "Quantity" : 15, "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 }