Jump to

• Request
• Response
• Examples

Update a planning resource for a project budget version

patch

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

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the project budget version.
• PlanningElementId(required): integer(int64)
  Identifier of the project 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• MaintainManualSpreadOnDateChanges: string
  Default Value: N

  Indicates if the periodic planning is retained on plan line date modifications.
• PlanningAmounts: array Planning Amounts
  Title: Planning Amounts

  The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.
• PlanningEndDate: string (date-time)
  Title: Planning Dates: To Date

  The finish date of the resource assignment on the task in the project budget version.
• PlanningStartDate: string (date-time)
  Title: Planning Dates: From Date

  The start date of the resource assignment on the task in the project budget version.

{
    "type":"object",
    "properties":{
        "PlanningStartDate":{
            "title":"Planning Dates: From Date",
            "type":"string",
            "description":"The start date of the resource assignment on the task in the project budget version.",
            "format":"date-time",
            "nullable":true
        },
        "PlanningEndDate":{
            "title":"Planning Dates: To Date",
            "type":"string",
            "description":"The finish date of the resource assignment on the task in the project budget version.",
            "format":"date-time",
            "nullable":true
        },
        "PlanningAmounts":{
            "title":"Planning Amounts",
            "type":"array",
            "description":"The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-item-patch-request"
            }
        },
        "MaintainManualSpreadOnDateChanges":{
            "type":"string",
            "description":"Indicates if the periodic planning is retained on plan line date modifications.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        }
    }
}

Nested Schema : Planning Amounts

Type: array

Title: Planning Amounts

The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.

Show Source

• Array of: object schema

{
    "title":"Planning Amounts",
    "type":"array",
    "description":"The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Budget line burdened cost amounts in transaction currency.
• Currency: string
  Maximum Length: 15

  Currency code for the budget lines.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

  Effective burdened cost rate for budget line.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Effective raw cost rate for budget line.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Effective revenue rate for budget line.
• ManualSpreadFlag: boolean
  Maximum Length: 1

  Indicates if the periodic planning is modified and retained for the plan line on date changes.
• 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 project budgets.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

  The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
• Quantity: number
  Title: Quantity

  Measure of the effort planned for the budget line.
• RawCostAmounts: number
  Title: Raw Cost

  Budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Budget line revenue amounts in transaction currency.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualSpreadFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.",
            "nullable":true
        },
        "PlanLinesDFF":{
            "title":"Plan Lines Descriptive Flexfields",
            "type":"array",
            "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the budget lines.",
            "nullable":false
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-patch-request"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 project budgets.

Show Source

• Array of: object schema

{
    "title":"Plan Lines Descriptive Flexfields",
    "type":"array",
    "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Planning Amount Details

Type: array

Title: Planning Amount Details

The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.

Show Source

• Array of: object schema

{
    "title":"Planning Amount Details",
    "type":"array",
    "description":"The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Name of the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Periodic 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.
• ManualSpreadFlag: boolean
  Maximum Length: 1

  Indicates if the periodic planning is modified and retained for the plan line on date changes.
• Quantity: number
  Title: Quantity

  Measure of the effort planned for the budget line by period.
• RawCostAmounts: number
  Title: Raw Cost

  Periodic budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Periodic budget line revenue amounts in transaction currency.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Periodic budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualSpreadFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the budget line by period.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : projectBudgets-PlanningResources-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintainManualSpreadOnDateChanges: string
  Default Value: N

  Indicates if the periodic planning is retained on plan line date modifications.
• PlanningAmounts: array Planning Amounts
  Title: Planning Amounts

  The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.
• PlanningElementId: integer (int64)
  Title: Planning Element ID

  Identifier of the project budget line.
• PlanningEndDate: string (date-time)
  Title: Planning Dates: To Date

  The finish date of the resource assignment on the task in the project budget version.
• PlanningStartDate: string (date-time)
  Title: Planning Dates: From Date

  The 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 Name

  Maximum Length: 240

  Name 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 Name

  Maximum Length: 255

  Name of the task to which a planning resource is assigned on a project budget line.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task to which a planning resource is assigned on a project budget line.
• UnitOfMeasure: string
  Read Only: true

  The unit, such as Hours, that is used to measure the work or effort that is planned for a resource.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"Identifier of the task to which a planning resource is assigned on a project budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"The unit, such as Hours, that is used to measure the work or effort that is planned for a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAmounts":{
            "title":"Planning Amounts",
            "type":"array",
            "description":"The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-item-response"
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task to which a planning resource is assigned on a project budget line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the resource which is assigned to a task on a project budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaintainManualSpreadOnDateChanges":{
            "type":"string",
            "description":"Indicates if the periodic planning is retained on plan line date modifications.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task to which a planning resource is assigned on a project budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanningElementId":{
            "title":"Planning Element ID",
            "type":"integer",
            "description":"Identifier of the project budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanningStartDate":{
            "title":"Planning Dates: From Date",
            "type":"string",
            "description":"The start date of the resource assignment on the task in the project budget version.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningEndDate":{
            "title":"Planning Dates: To Date",
            "type":"string",
            "description":"The finish date of the resource assignment on the task in the project budget version.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RbsElementId":{
            "type":"integer",
            "description":"Identifier of the resource which is assigned to a task on a project budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Planning Amounts

Type: array

Title: Planning Amounts

The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.

Show Source

• Array of: object projectBudgets-PlanningResources-PlanningAmounts-item-response

{
    "title":"Planning Amounts",
    "type":"array",
    "description":"The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Budget line burdened cost amounts in transaction currency.
• Currency: string
  Maximum Length: 15

  Currency code for the budget lines.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

  Effective burdened cost rate for budget line.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Effective raw cost rate for budget line.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Effective revenue rate for budget line.
• 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.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

  Budget line burdened cost amounts in project currency.
• PCRawCostAmounts: number
  Title: Raw Cost in Project Currency

  Read Only: true

  Budget line raw cost amounts in project currency.
• PCRevenueAmounts: number
  Title: Revenue in Project Currency

  Read Only: true

  Budget line revenue amounts in project currency.
• PFCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

  Budget line burdened cost amounts in project ledger currency.
• PFCRawCostAmounts: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Budget line raw cost amounts in project ledger currency.
• PFCRevenueAmounts: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Budget 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 Flexfields

  The 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 Details

  The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
• Quantity: number
  Title: Quantity

  Measure of the effort planned for the budget line.
• RawCostAmounts: number
  Title: Raw Cost

  Budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Budget line revenue amounts in transaction currency.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Standard burdened cost rate for budget line.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Standard raw cost rate for budget line.
• StandardRevenueRate: number
  Title: Standard Revenue Rate

  Read Only: true

  Standard revenue rate for budget line.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "PlanLineId":{
            "type":"integer",
            "description":"Identifier of the planning amounts for a resource assignment in the project budget version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManualSpreadFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Standard burdened cost rate for budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Standard raw cost rate for budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLinesDFF":{
            "title":"Plan Lines Descriptive Flexfields",
            "type":"array",
            "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the budget lines.",
            "nullable":false,
            "x-queryable":true
        },
        "StandardRevenueRate":{
            "title":"Standard Revenue Rate",
            "type":"number",
            "description":"Standard revenue rate for budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Budget line raw cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for budget line.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Budget line burdened cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Budget line revenue amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Budget line raw cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRevenueAmounts":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"Budget line revenue amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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 project budgets.

Show Source

• Array of: object projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response

{
    "title":"Plan Lines Descriptive Flexfields",
    "type":"array",
    "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Planning Amount Details

Type: array

Title: Planning Amount Details

The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.

Show Source

• Array of: object projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response

{
    "title":"Planning Amount Details",
    "type":"array",
    "description":"The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response"
    }
}

Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response

Type: object

Show Source

• __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 project budget.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanLineId":{
            "type":"integer",
            "description":"Identifier of the summary level planning amounts for a plan line in the project budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Name of the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Periodic 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.
• ManualSpreadFlag: boolean
  Maximum Length: 1

  Indicates if the periodic planning is modified and retained for the plan line on date changes.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

  Periodic budget line burdened cost amounts in project currency.
• PCRawCostAmounts: number
  Title: Raw Cost in Project Currency

  Read Only: true

  Periodic budget line raw cost amounts in project currency.
• PCRevenueAmounts: number
  Title: Revenue in Project Currency

  Read Only: true

  Periodic 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 budget line burdened cost amounts in project ledger currency.
• PFCRawCostAmounts: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Periodic budget line raw cost amounts in project ledger currency.
• PFCRevenueAmounts: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Periodic budget line revenue amounts in project ledger currency.
• PlanLineDetailId: integer (int64)
  Title: Plan Line Details ID

  Identifier of the periodic level planning amounts for a resource assignment in the project budget version.
• Quantity: number
  Title: Quantity

  Measure of the effort planned for the budget line by period.
• RawCostAmounts: number
  Title: Raw Cost

  Periodic budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Periodic 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.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Periodic budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualSpreadFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the budget line by period.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Standard burdened cost rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Periodic budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Standard raw cost rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRevenueRate":{
            "title":"Standard Revenue Rate",
            "type":"number",
            "description":"Standard revenue rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Periodic budget line raw cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Periodic budget line burdened cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodName":{
            "maxLength":"30",
            "type":"string",
            "description":"Period for which the periodic budget amount is entered.",
            "nullable":true,
            "x-queryable":true
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Periodic budget line revenue amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLineDetailId":{
            "title":"Plan Line Details ID",
            "type":"integer",
            "description":"Identifier of the periodic level planning amounts for a resource assignment in the project budget version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Periodic budget line raw cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRevenueAmounts":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"Periodic budget line revenue amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

PlanningAmounts

Operation: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/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.

Back to Top

Examples

The following example shows how to update a planning resource for a project budget version using a batch operation.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.oracle.adf.batch+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
   "parts":[
      {
         "id":"part1",
         "path":"/projectBudgets/10189/child/PlanningResources/450376",
         "operation":"update",
         "payload":{
           "PlanningEndDate": "2019-08-01T00:00:00+00:00"
           
         }
      },
            {
         "id":"part2",
         "path":"/projectBudgets/10189/child/PlanningResources/450213",
         "operation":"update",
         "payload":{
           "PlanningEndDate": "2020-08-01T00:00:00+00:00"
           
         }
      }
   ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"parts": [
  {
"id": "part1",
"path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376",
"operation": "update",
"payload": {
"PlanningElementId": 450376,
"TaskId": 100000041159879,
"TaskNumber": "1",
"TaskName": "Pre-Implementation Preparation",
"RbsElementId": 100000041113231,
"ResourceName": "Per Diem",
"UnitOfMeasure": "DOLLARS",
"PlanningStartDate": "2008-01-01T00:00:00+00:00",
"PlanningEndDate": "2019-08-01T00:00:00+00:00",
"links": [
  {
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376",
"name": "PlanningResources",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
  {
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376",
"name": "PlanningResources",
"kind": "item"
},
  {
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189",
"name": "projectBudgets",
"kind": "item"
},
  {
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376/lov/PrimaryPlanningRBSLOVVO",
"name": "PrimaryPlanningRBSLOVVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376/lov/FinancialTaskVersionLOVVO",
"name": "FinancialTaskVersionLOVVO",
"kind": "collection"
},
  {
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450376/child/PlanningAmounts",
"name": "PlanningAmounts",
"kind": "collection"
}
],
}
},
  {
"id": "part2",
"path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213",
"operation": "update",
"payload": {
"PlanningElementId": 450213,
"TaskId": 100000041159879,
"TaskNumber": "1",
"TaskName": "Pre-Implementation Preparation",
"RbsElementId": 100000042522489,
"ResourceName": "Labor-Patel, Ravi",
"UnitOfMeasure": "HOURS",
"PlanningStartDate": "2008-01-01T00:00:00+00:00",
"PlanningEndDate": "2020-08-01T00:00:00+00:00",
"links": [
  {
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213",
"name": "PlanningResources",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
  {
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213",
"name": "PlanningResources",
"kind": "item"
},
  {
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189",
"name": "projectBudgets",
"kind": "item"
},
  {
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213/lov/PrimaryPlanningRBSLOVVO",
"name": "PrimaryPlanningRBSLOVVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213/lov/FinancialTaskVersionLOVVO",
"name": "FinancialTaskVersionLOVVO",
"kind": "collection"
},
  {
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/10189/child/PlanningResources/450213/child/PlanningAmounts",
"name": "PlanningAmounts",
"kind": "collection"
}
],
}
}
],
}

Back to Top