1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Award Budget Summary

Get all award budget versions

get

/fscmRestApi/resources/11.13.18.05/awardBudgetSummary

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • CurrentBaselineAwardBudgetFinder: Finds the current baseline award budget for the specified award and financial plan type.
      Finder Variables:
      • AwardId; integer; Identifier of the award on which the budget is created.
      • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
      • ProjectId; integer; Identifier of the project on which the award budget is created.
    • CurrentWorkingAwardBudgetFinder: Finds the current working award budget for the specified award and financial plan type.
      Finder Variables:
      • AwardId; integer; Identifier of the award on which the budget is created.
      • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
      • ProjectId; integer; Identifier of the project on which the award budget is created.
    • PrimaryKey: Finds the award budget version.
      Finder Variables:
      • PlanVersionId; integer; Identifier of the award budget version.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AwardId; integer; Identifier of the award on which the budget is created.
    • AwardName; string; Name of the award on which the budget is created.
    • AwardNumber; string; Number of the award on which the budget is created.
    • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
    • PCBurdenedCostAmounts; number; Budget burdened cost amounts in project currency for the award budget version.
    • PCRawCostAmounts; number; Budget raw cost amounts in project currency for the award budget version.
    • PCRevenueAmounts; number; Budget revenue amounts in project currency for the award budget version.
    • PFCBurdenedCostAmounts; number; Budget burdened cost amounts in project ledger currency for the award budget version.
    • PFCRawCostAmounts; number; Budget raw cost amounts in project ledger currency for the award budget version.
    • PFCRevenueAmounts; number; Budget revenue amounts in project ledger currency for the award budget version.
    • PlanVersionDescription; string; Plan version description for the award budget.
    • PlanVersionId; integer; Identifier of the award budget version.
    • PlanVersionName; string; Plan version name for the award budget.
    • PlanVersionNumber; integer; Plan version number for the award budget.
    • PlanVersionStatus; string; Plan version status for the award budget.
    • PlanningAmounts; string; The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.
    • ProjectId; integer; Identifier of the project on which the award budget is created.
    • ProjectName; string; Name of the project on which the award budget is created.
    • ProjectNumber; string; Number of the project on which the award budget is created.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : awardBudgetSummary
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : awardBudgetSummary-item-response
Type: object
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget.
Show Source
Nested Schema : Tasks
Type: array
Title: Tasks
The Tasks resource is used to view an award budget version task.
Show Source
Nested Schema : Version Errors
Type: array
Title: Version Errors
The Version Errors resource is used to view award budget version errors.
Show Source
Nested Schema : awardBudgetSummary-Resources-item-response
Type: object
Show Source
Nested Schema : Budget Lines
Type: array
Title: Budget Lines
The Budget Lines resource is used to view the budget lines for a resource.
Show Source
Nested Schema : awardBudgetSummary-Resources-BudgetLines-item-response
Type: object
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view periodic amounts for a budget line.
Show Source
Nested Schema : awardBudgetSummary-Resources-BudgetLines-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : awardBudgetSummary-Tasks-item-response
Type: object
Show Source
Nested Schema : Budget Lines
Type: array
Title: Budget Lines
The Budget Lines resource is used to view the budget lines for a task.
Show Source
Nested Schema : awardBudgetSummary-Tasks-BudgetLines-item-response
Type: object
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view periodic amounts for a budget line.
Show Source
Nested Schema : awardBudgetSummary-Tasks-BudgetLines-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : awardBudgetSummary-VersionErrors-item-response
Type: object
Show Source
  • Title: Severity
    Read Only: true
    Maximum Length: 30
    Specifies whether a warning or error.
  • Links
  • Read Only: true
    Maximum Length: 4000
    Explanation for the reason of an error or warning message.
  • Read Only: true
    Maximum Length: 30
    Message code for the issue encountered.
  • Title: Message Text
    Read Only: true
    Maximum Length: 240
    Error or warning that occurs or information that informs users, to know what action to take or to understand what is happening.
  • Read Only: true
    Maximum Length: 4000
    States the response that end users must perform to continue and complete their tasks in response to an error or warning message.
  • Read Only: true
    Maximum Length: 4000
    More detailed explanation of message text that states why the message occurred.
  • Title: Period
    Read Only: true
    Maximum Length: 30
    Period for which the periodic budget amount is entered.
  • Read Only: true
    Identifier of the award budget version.
  • Title: Resource
    Read Only: true
    Maximum Length: 240
    The name of the resource used to create the budget line.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task which is used to create a budget line.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task which is used to create a budget line.
  • Read Only: true
    Position of the task in the task hierarchy.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    Currency code for the budget lines.
Back to Top

Examples

The following example shows how to get all award budgets version for an award 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/awardBudgetSummary

Example of Response Body

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

{
"items": [
  {
"FinancialPlanType": "Award Cost Budget - Approved",
"PlanVersionId": 100100053015964,
"PlanVersionNumber": 2,
"PlanVersionName": "Version 2",
"PlanVersionDescription": null,
"PlanVersionStatus": "Current Working",
"AwardId": 300100090708043,
"AwardNumber": "Award_001",
"AwardName": "Award_001",
"ProjectId": 300100095525314,
"ProjectNumber": "Award_PRJ1",
"ProjectName": "Award_PRJ1",
"PlanningAmounts": "COST",
"PCRawCostAmounts": 1925,
"PCBurdenedCostAmounts": 2310,
"PCRevenueAmounts": 0,
"PFCRawCostAmounts": 1925,
"PFCBurdenedCostAmounts": 2310,
"PFCRevenueAmounts": 0,
"links": [
  {
"rel": "self",
"href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964",
"name": "awardBudgetSummary",
"kind": "item"
},
  {
"rel": "canonical",
"href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964",
"name": "awardBudgetSummary",
"kind": "item"
},
  {
"rel": "child",
"href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/VersionErrors",
"name": "VersionErrors",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/Tasks",
"name": "Tasks",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/Resources",
"name": "Resources",
"kind": "collection"
}
],
},
  {
"FinancialPlanType": "Award Cost Budget - Approved",
"PlanVersionId": 300100095525369,
"PlanVersionNumber": 1,
"PlanVersionName": "Version 1",
"PlanVersionDescription": null,
"PlanVersionStatus": "Current and Original Baseline",
"AwardId": 300100090708043,
"AwardNumber": "Award_001",
"AwardName": "Award_001",
"ProjectId": 300100095525314,
"ProjectNumber": "Award_PRJ1",
"ProjectName": "Award_PRJ1",
"PlanningAmounts": "COST",
"PCRawCostAmounts": 1925,
"PCBurdenedCostAmounts": 2310,
"PCRevenueAmounts": 0,
"PFCRawCostAmounts": 1925,
"PFCBurdenedCostAmounts": 2310,
"PFCRevenueAmounts": 0,
  {
"FinancialPlanType": "Award Cost Budget - Approved",
"PlanVersionId": 300100136398137,
"PlanVersionNumber": 1,
"PlanVersionName": "Version 1",
"PlanVersionDescription": null,
"PlanVersionStatus": "Current and Original Baseline",
"AwardId": 300100136414130,
"AwardNumber": "Donut_Underspent",
"AwardName": "Donut_Underspent",
"ProjectId": 300100136398095,
"ProjectNumber": "Donut_Underspent",
"ProjectName": "Donut_Underspent",
"PlanningAmounts": "COST",
"PCRawCostAmounts": 5000000,
"PCBurdenedCostAmounts": 5000000,
"PCRevenueAmounts": 0,
"PFCRawCostAmounts": 5000000,
"PFCBurdenedCostAmounts": 5000000,
"PFCRevenueAmounts": 0,
}
Back to Top