Jump to

• Request
• Response
• Examples

Create a plan line for a planning resource

post

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

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the award budget version.
• PlanningElementId(required): integer(int64)
  Identifier of the award budget line.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Currency(required): string
  Maximum Length: 15

  Currency code for the award budget lines.
• PlanLineId: integer (int64)
  Title: Plan Line ID

  Identifier of the award budget line amounts.
• PlanLinesDFF: array Plan Lines Descriptive Flexfields
  Title: Plan Lines Descriptive Flexfields

  The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

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

{
    "required":[
        "Currency"
    ],
    "type":"object",
    "properties":{
        "PlanLineId":{
            "title":"Plan Line ID",
            "type":"integer",
            "description":"Identifier of the award budget line amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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 award budgets.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the award budget lines.",
            "nullable":false
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, and update an award  budget line periodic amounts.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-post-request"
            }
        }
    }
}

Nested Schema : Plan Lines Descriptive Flexfields

Type: array

Title: Plan Lines Descriptive Flexfields

The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.

Show Source

• 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 award budgets.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-post-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 an award budget line periodic amounts.

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 an award  budget line periodic amounts.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-post-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.
• PlanLineId: integer (int64)
  Identifier of the summary level planning amounts for a plan line in the award budget.

{
    "type":"object",
    "properties":{
        "PlanLineId":{
            "type":"integer",
            "description":"Identifier of the summary level planning amounts for a plan line in the award budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__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 award budget line burdened cost amounts in transaction currency.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

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

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

  Effective revenue rate for periodic line.
• PeriodName: string
  Maximum Length: 30

  Period for which the periodic budget amount is entered.
• PlanLineDetailId: integer (int64)
  Title: Plan Line Details ID

  Identifier of the award budget periodic amounts.
• Quantity: number
  Title: Quantity

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

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

  Periodic award budget line revenue amounts in transaction currency.

{
    "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 award budget line revenue amounts in transaction currency.",
            "nullable":true
        },
        "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 award budget line raw cost amounts in transaction currency.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award 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
        },
        "PeriodName":{
            "maxLength":"30",
            "type":"string",
            "description":"Period for which the periodic budget amount is entered.",
            "nullable":true
        },
        "PlanLineDetailId":{
            "title":"Plan Line Details ID",
            "type":"integer",
            "description":"Identifier of the award budget periodic amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in transaction currency.",
            "nullable":true
        }
    }
}

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 : awardBudgets-PlanningResources-PlanningAmounts-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Read Only: true

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Effective revenue rate for award budget line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Award budget line revenue amounts in project ledger currency.
• PlanLineId: integer (int64)
  Title: Plan Line ID

  Identifier of the award budget line amounts.
• PlanLinesDFF: array Plan Lines Descriptive Flexfields
  Title: Plan Lines Descriptive Flexfields

  The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Standard revenue rate for award budget line.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Award budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLineId":{
            "title":"Plan Line ID",
            "type":"integer",
            "description":"Identifier of the award budget line amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, and update an award  budget line periodic amounts.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Award budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Standard burdened cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Award budget line revenue amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Award budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Standard raw cost rate for award 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 award budgets.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the award budget lines.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRevenueRate":{
            "title":"Standard Revenue Rate",
            "type":"number",
            "description":"Standard revenue rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Award budget line raw cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":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":"Award budget line burdened cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Award budget line revenue amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Award 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":"Award 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 award budgets.

Show Source

• Array of: object awardBudgets-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 award budgets.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-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 an award budget line periodic amounts.

Show Source

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

{
    "title":"Planning Amount Details",
    "type":"array",
    "description":"The Planning Amount Details resource is used to view, create, and update an award  budget line periodic amounts.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-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 : awardBudgets-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 award 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 award 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 : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Periodic award budget line burdened cost amounts in transaction currency.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

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

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

  Effective revenue rate for periodic line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Periodic award budget line revenue amounts in project currency.
• PeriodName: string
  Maximum Length: 30

  Period for which the periodic budget amount is entered.
• PFCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Identifier of the award budget periodic amounts.
• Quantity: number
  Title: Quantity

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

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Standard revenue rate for periodic line.

{
    "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 award budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award budget line by period.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "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 award budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic award budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "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 award 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 award 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 award 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 award budget periodic amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Periodic award 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 award 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

PlanLinesDFF

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

PlanningAmountDetails

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{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, and update an award budget line periodic amounts.

adjust

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust

Parameters:

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

Adjusts the award budget line using the adjustment parameters.

refreshRates

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates

Parameters:

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

Refresh rates for the award budget line.

Back to Top

Examples

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

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts

Request Body Example

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

{
 "PeriodName": "YrStartOct-12",
 "RawCostAmounts": 40000,
 "BurdenedCostAmounts": 40000          
}

Response Body Example

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

{
        "PeriodName" : "YrStartOct-12",
        "Quantity" : null,
        "RawCostAmounts" : 40000,
        "BurdenedCostAmounts" : 40000,
        "RevenueAmounts" : null,
        "EffectiveRawCostRate" : null,
        "StandardRawCostRate" : null,
        "EffectiveBurdenedCostRate" : null,
        "StandardBurdenedCostRate" : null,
        "EffectiveRevenueRate" : null,
        "StandardRevenueRate" : null,
        "PCRawCostAmounts" : null,
        "PCBurdenedCostAmounts" : null,
        "PCRevenueAmounts" : null,
        "PFCRawCostAmounts" : null,
        "PFCBurdenedCostAmounts" : null,
        "PFCRevenueAmounts" : null
}

Back to Top