Jump to

• Request
• Response

Update a planning amount detail for a period for a plan line

patch

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

Request

Path Parameters

• PlanLineDetailId(required): integer(int64)
  Identifier of the award budget periodic amounts.
• PlanLineId(required): integer(int64)
  Identifier of the summary level planning amounts for a planning resource in the award budget.
• PlanVersionId(required): integer(int64)
  Identifier of the award budget version.
• PlanningElementId(required): integer(int64)
  Identifier of the award budget line.

Header Parameters

• Metadata-Context: string
  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: string
  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

• BurdenedCostAmounts: number
  Title: Burdened Cost

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

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

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

  Effective revenue rate for periodic line.
• Quantity: number
  Title: Quantity

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

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

  Periodic award budget line revenue amounts in transaction currency.

{
    "type":"object",
    "properties":{
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in transaction currency.",
            "nullable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for periodic line.",
            "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
        },
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award budget line by period.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Periodic award budget line raw cost amounts in transaction currency.",
            "nullable":true
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic award budget line revenue 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-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":{
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for periodic line.",
            "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
        },
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PeriodName":{
            "maxLength":30,
            "type":"string",
            "description":"Period for which the periodic budget amount is entered.",
            "nullable":true,
            "x-queryable":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
            },
            "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
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Periodic award budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic award budget line revenue 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

adjust

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

Parameters:

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

Adjusts the award budget line period using the adjustment parameters.

Back to Top