Update a planning resource for an award budget version

patch

/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
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 : awardBudgets-PlanningResources-PlanningAmounts-item-patch-request
Type: object
Show Source
Nested Schema : PlanLinesDFF
Type: array
Show Source
Nested Schema : PlanningAmountDetails
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : awardBudgets-PlanningResources-item-response
Type: object
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 : awardBudgets-PlanningResources-PlanningAmounts-item-response
Type: object
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: object
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type: object
Show Source
Back to Top

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
}
Back to Top