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

Get all project budget versions

get

/fscmRestApi/resources/11.13.18.05/projectBudgetSummary

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:

    • CurrentBaselineProjectBudgetFinder: Finds the current baseline project budget for the specified project and financial plan type.
      Finder Variables:
      • FinancialPlanType; string; Name of the financial plan type used to create the budget version.
      • ProjectId; integer; Identifier of the project on which the budget is created.
    • CurrentWorkingProjectBudgetFinder: Finds the current working project budget for the specified project and financial plan type.
      Finder Variables:
      • FinancialPlanType; string; Name of the financial plan type used to create the budget version.
      • ProjectId; integer; Identifier of the project on which the budget is created.
    • PrimaryKey: Finds the project budget version.
      Finder Variables:
      • PlanVersionId; integer; Identifier of the project 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:
    • FinancialPlanType; string; Name of the financial plan type used to create the project budget version.
    • PCBurdenedCostAmounts; number; Budget burdened cost amounts in project currency for the project budget version.
    • PCRawCostAmounts; number; Budget raw cost amounts in project currency for the project budget version.
    • PCRevenueAmounts; number; Budget revenue amounts in project currency for the project budget version.
    • PFCBurdenedCostAmounts; number; Budget burdened cost amounts in project ledger currency for the project budget version.
    • PFCRawCostAmounts; number; Budget raw cost amounts in project ledger currency for the project budget version.
    • PFCRevenueAmounts; number; Budget revenue amounts in project ledger currency for the project budget version.
    • PlanVersionDescription; string; Description of the project budget version.
    • PlanVersionId; integer; Identifier of the project budget version.
    • PlanVersionName; string; Name of the project budget version.
    • PlanVersionNumber; integer; Number of the project budget version.
    • PlanVersionStatus; string; Status of the project budget version.
    • 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 project budget is created.
    • ProjectName; string; Name of the project on which the project budget is created.
    • ProjectNumber; string; Number of the project on which the project 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 : projectBudgetSummary
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectBudgetSummary-item-response
Type: object
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource is used to view a project budget version resource.
Show Source
Nested Schema : Tasks
Type: array
Title: Tasks
The Tasks resource is used to view a project budget version task.
Show Source
Nested Schema : Version Errors
Type: array
Title: Version Errors
The Version Errors resource is used to view project budget version errors.
Show Source
Nested Schema : projectBudgetSummary-Resources-item-response
Type: object
Show Source
Nested Schema : Budget Lines
Type: array
Title: Budget Lines
The Budget Lines resource is used to view a resource's project budget line.
Show Source
Nested Schema : projectBudgetSummary-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 a project budget line periodic amounts.
Show Source
Nested Schema : projectBudgetSummary-Resources-BudgetLines-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : projectBudgetSummary-Tasks-item-response
Type: object
Show Source
Nested Schema : Budget Lines
Type: array
Title: Budget Lines
The Budget Lines resource is used to view a task's project budget line.
Show Source
Nested Schema : projectBudgetSummary-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 a project budget line periodic amounts.
Show Source
Nested Schema : projectBudgetSummary-Tasks-BudgetLines-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : projectBudgetSummary-VersionErrors-item-response
Type: object
Show Source
  • Title: Severity
    Read Only: true
    Maximum Length: 30
    Indicates the type of the exception, for example, Error or Warning.
  • Links
  • Read Only: true
    Maximum Length: 4000
    Reason due to which the error in the budget version occurred.
  • Read Only: true
    Maximum Length: 30
    Name that identifies the message uniquely.
  • Title: Message Text
    Read Only: true
    Maximum Length: 240
    Text of the message that indicates the cause and resolution of the error.
  • Read Only: true
    Maximum Length: 4000
    The action that you must perform to resolve the error.
  • Read Only: true
    Maximum Length: 4000
    Additional information about the cause and resolution of the error.
  • Title: Period
    Read Only: true
    Maximum Length: 30
    Period for which errors exist in the project budget version.
  • Read Only: true
    Identifier of the project budget version that has errors.
  • Title: Resource
    Read Only: true
    Maximum Length: 240
    Name of the resource in the project budget version that has errors.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task in the project budget version that has errors.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task in the project budget version that has errors.
  • Read Only: true
    Position of the project task in a hierarchical arrangement.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    Planning currency used in the project budget version.
Back to Top

Examples

The following example shows how to get all project budget versions 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/projectBudgetSummary

Example of Response Body

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

{ "items": [ { "FinancialPlanType": "PSR CostRev Budget", "PlanVersionId": 10733, "PlanVersionNumber": 2, "PlanVersionName": "Version 2", "PlanVersionDescription": null, "PlanVersionStatus": "Current Working", "ProjectId": 999991025, "ProjectNumber": "SMSEG-0000000000000000026", "ProjectName": "SMName-000000000000000026", "PlanningAmounts": "COST_AND_REV_TOGETHER", "PCRawCostAmounts": 1278040, "PCBurdenedCostAmounts": 1917060, "PCRevenueAmounts": 2556080, "PFCRawCostAmounts": 0, "PFCBurdenedCostAmounts": 0, "PFCRevenueAmounts": 0 }
Back to Top