Jump to

• Request
• Response
• Examples

Get a planning amount for a resource assignment

get

/fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}

Request

Path Parameters

• PlanLineId(required): integer(int64)
  Identifier of the summary level planning amounts for a resource assignment in the financial project plan.
• PlanVersionId(required): number
  Identifier of the financial project plan version.
• PlanningElementId(required): integer(int64)
  Identifier of the resource assignment on the financial project plan version.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response

Type: object

Show Source

• BaselineBurdenedCost: number
  Title: Baseline Burdened Cost

  Read Only: true

  Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency.
• BaselineBurdenedCostInProjectCurrency: number
  Title: Rolled-up Baseline Cost for Resource in Project Currency

  Read Only: true

  Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency.
• BaselineBurdenedCostInProjectLedgerCurrency: number
  Title: Baseline Burdened Cost

  Read Only: true

  Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
• BaselineCurrency: string
  Title: Baseline Currency

  Read Only: true

  Maximum Length: 30

  Currency of the rendered baseline amounts.
• BaselineQuantity: number
  Title: Baseline Quantity

  Read Only: true

  Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours.
• BaselineRawCost: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed.
• BaselineRawCostInProjectCurrency: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed.
• BaselineRawCostInProjectLedgerCurrency: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• BurdenedCost: number
  Title: Burdened Cost

  Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs.
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency: Total

  Read Only: true

  Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
• Currency: string
  Title: Currency

  Maximum Length: 15

  Code that identifies the planning currency on the financial project plan resource assignment.
• EffectiveBurdenedCostRate: number
  Title: Average Effective Burden Cost Rate

  Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
• ITDActualBurdenedCost: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectLedgerCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
• ITDActualQuantity: number
  Title: ITD Actual Quantity

  Read Only: true

  Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
• ITDActualRawCost: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectCurrency: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectLedgerCurrency: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
• 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.
• PlanLineId: integer (int64)
  Title: Plan Line ID

  Identifier of the summary level planning amounts for a resource assignment in the financial project plan.
• 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 financial project plans.
• PlannedQuantity: number
  Title: Planned Quantity

  Measure of the effort planned for in the financial project plan resource assignment, expressed in hours.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

  The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.
• RawCost: number
  Title: Raw Cost

  Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency: Total

  Read Only: true

  Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed.
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.

{
    "type":"object",
    "properties":{
        "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
        },
        "ITDActualRawCostInProjectCurrency":{
            "title":"ITD Actual Raw Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCostInProjectLedgerCurrency":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCost":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.",
            "items":{
                "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response"
            }
        },
        "BaselineBurdenedCostInProjectCurrency":{
            "title":"Rolled-up Baseline Cost for Resource in Project Currency",
            "type":"number",
            "description":"Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCostInProjectLedgerCurrency":{
            "title":"ITD Actual Burdened Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "BaselineCurrency":{
            "title":"Baseline Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Currency of the rendered baseline amounts.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineRawCostInProjectCurrency":{
            "title":"Baseline Raw Cost",
            "type":"number",
            "description":"Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCostInProjectCurrency":{
            "title":"ITD Actual Burdened Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedQuantity":{
            "title":"Planned Quantity",
            "type":"number",
            "description":"Measure of the effort planned for in the financial project plan resource assignment, expressed in hours.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency: Total",
            "type":"number",
            "description":"Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the planning currency on the financial project plan resource assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "ITDActualQuantity":{
            "title":"ITD Actual Quantity",
            "type":"number",
            "description":"Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Average Effective Burden Cost Rate",
            "type":"number",
            "description":"Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BurdenedCost":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs.",
            "nullable":true,
            "x-queryable":true
        },
        "BaselineRawCostInProjectLedgerCurrency":{
            "title":"Baseline Raw Cost",
            "type":"number",
            "description":"Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineBurdenedCost":{
            "title":"Baseline Burdened Cost",
            "type":"number",
            "description":"Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanLineId":{
            "title":"Plan Line ID",
            "type":"integer",
            "description":"Identifier of the summary level planning amounts for a resource assignment in the financial project plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ITDActualRawCost":{
            "title":"ITD Actual Raw Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCost":{
            "title":"ITD Actual Burdened Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineRawCost":{
            "title":"Baseline Raw Cost",
            "type":"number",
            "description":"Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualRawCostInProjectLedgerCurrency":{
            "title":"ITD Actual Raw Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineQuantity":{
            "title":"Baseline Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency: Total",
            "type":"number",
            "description":"Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectLedgerCurrency":{
            "title":"Burdened Cost in Project Ledger Currency: Total",
            "type":"number",
            "description":"Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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 financial project plans.",
            "items":{
                "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "BaselineBurdenedCostInProjectLedgerCurrency":{
            "title":"Baseline Burdened Cost",
            "type":"number",
            "description":"Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version.",
            "nullable":true,
            "readOnly":true,
            "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 : 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 financial project plans.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-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 financial project plans.",
    "items":{
        "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-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, update, and delete a financial project plan resource assignment periodic amounts.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response

{
    "title":"Planning Amount Details",
    "type":"array",
    "description":"The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.",
    "items":{
        "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-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 : financialProjectPlans-ResourceAssignments-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 financial project plan.

{
    "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 financial project plan.",
            "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 : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response

Type: object

Show Source

• BurdenedCost: number
  Title: Planned Burdened Cost

  Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs.
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency: Total

  Read Only: true

  Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost Rate

  Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
• EffectiveRawCostRate: number
  Title: Effective Rate

  Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
• ITDActualBurdenedCost: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
• ITDActualQuantity: number
  Title: ITD Actual Quantity

  Read Only: true

  Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
• ITDActualRawCost: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectCurrency: number
  Title: ITD Actual in Project Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
• 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.
• PeriodName: string
  Title: Period

  Maximum Length: 30

  Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan.
• PlannedQuantity: number
  Title: Planned Quantity

  Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours.
• RawCost: number
  Title: Raw cost

  Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency: Total

  Read Only: true

  Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed.
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency: Total

  Read Only: true

  Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.

{
    "type":"object",
    "properties":{
        "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
        },
        "ITDActualRawCost":{
            "title":"ITD Actual Raw Cost",
            "type":"number",
            "description":"Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCost":{
            "title":"ITD Actual Burdened Cost",
            "type":"number",
            "description":"Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualRawCostInProjectCurrency":{
            "title":"ITD Actual in Project Currency",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCostInProjectLedgerCurrency":{
            "title":"Raw Cost in Project Ledger Currency: Total",
            "type":"number",
            "description":"Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCost":{
            "title":"Raw cost",
            "type":"number",
            "description":"Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed.",
            "nullable":true,
            "x-queryable":true
        },
        "ITDActualRawCostInProjectLedgerCurrency":{
            "title":"ITD Actual in Project Ledger Currency",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCostInProjectLedgerCurrency":{
            "title":"ITD Actual in Project Ledger Currency",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency: Total",
            "type":"number",
            "description":"Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectLedgerCurrency":{
            "title":"Burdened Cost in Project Ledger Currency: Total",
            "type":"number",
            "description":"Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveRawCostRate":{
            "title":"Effective Rate",
            "type":"number",
            "description":"Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualBurdenedCostInProjectCurrency":{
            "title":"ITD Actual Burdened Cost",
            "type":"number",
            "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedQuantity":{
            "title":"Planned Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency: Total",
            "type":"number",
            "description":"Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ITDActualQuantity":{
            "title":"ITD Actual Quantity",
            "type":"number",
            "description":"Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost Rate",
            "type":"number",
            "description":"Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCost":{
            "title":"Planned Burdened Cost",
            "type":"number",
            "description":"Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs.",
            "nullable":true,
            "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"
    }
}

Links

PlanLinesDFF

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF

Parameters:

• PlanLineId: $request.path.PlanLineId
• PlanVersionId: $request.path.PlanVersionId
• PlanningElementId: $request.path.PlanningElementId

The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.

PlanningAmountDetails

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails

Parameters:

• PlanLineId: $request.path.PlanLineId
• PlanVersionId: $request.path.PlanVersionId
• PlanningElementId: $request.path.PlanningElementId

The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.

adjust

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust

Parameters:

• PlanLineId: $request.path.PlanLineId
• PlanVersionId: $request.path.PlanVersionId
• PlanningElementId: $request.path.PlanningElementId

Adjusts the financia project plan line using the adjustment parameters.

refreshRates

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates

Parameters:

• PlanLineId: $request.path.PlanLineId
• PlanVersionId: $request.path.PlanVersionId
• PlanningElementId: $request.path.PlanningElementId

Refreshes rates for the financial project plan line.

updatePlannedAmountsFromProgress

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/updatePlannedAmountsFromProgress

Parameters:

• PlanLineId: $request.path.PlanLineId
• PlanVersionId: $request.path.PlanVersionId
• PlanningElementId: $request.path.PlanningElementId

Updates planned amounts from progress for a resource.

Back to Top

Examples

The following example shows how to get a planning amount for a resource assignment by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/4067307/child/ResourceAssignments/1987603435/child/PlanningAmounts/27065059209

Response Body Example

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

{
"PlanLineId": 27065059209,
"PlannedQuantity": 3030,
"ITDActualQuantity": null,
"BaselineQuantity": null,
"Currency": "USD",
"RawCost": 6060,
"ITDActualRawCost": null,
"BaselineRawCost": null,
"BurdenedCost": 9090,
"ITDActualBurdenedCost": null,
"BaselineBurdenedCost": null,
"EffectiveRawCostRate": 2,
"StandardRawCostRate": null,
"EffectiveBurdenedCostRate": 3,
"StandardBurdenedCostRate": null,
"RawCostInProjectCurrency": 6060,
"ITDActualRawCostInProjectCurrency": null,
"BaselineRawCostInProjectCurrency": null,
"BurdenedCostInProjectCurrency": 9090,
"ITDActualBurdenedCostInProjectCurrency": null,
"BaselineBurdenedCostInProjectCurrency": null,
"RawCostInProjectLedgerCurrency": 6060,
"ITDActualRawCostInProjectLedgerCurrency": null,
"BaselineRawCostInProjectLedgerCurrency": null,
"BurdenedCostInProjectLedgerCurrency": 9090,
"ITDActualBurdenedCostInProjectLedgerCurrency": null,
"BaselineBurdenedCostInProjectLedgerCurrency": null
}

Back to Top