1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Financial Project Plans
  4. Planning Options

Get all planning options

get

/fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions

Request

Path Parameters
Query Parameters
  • 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>
  • 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:

    • PrimaryKey
      Finder Variables:
      • PlanningOptionId
  • 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:
    • AllowNegativeETCCalculationFlag; boolean; Indicates whether estimate-to-complete values can be lesser than zero. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • AssociateProjectCostsToSummaryTaskAssignmentsFlag; boolean; Indicates whether project costs for a resource assignment from a lowest level task can be associated to a planned resource assignment on the financial project plan at a higher level in the task structure. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • AutoApproveFlag; boolean; Indicates if the forecast that's created using the financial plan type is automatically approved.
    • AutoBaselineFlag; boolean; Indicates if the budget that's created using the financial plan type is automatically set to baseline.
    • AutomaticallyGenerateBudgetVersionFlag; boolean; Indicates if a budget is being created using the financial plan type while baseline of the financial project plan. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • AutomaticallyGenerateForecastVersionFlag; boolean; Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • BudgetFinancialPlanType; string; The name of the financial plan type that's used to create the budget version.
    • BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates; number; Buffer value to adjust the task transaction dates to be changed along with the task planned dates.
    • BurdenScheduleCostOptions; string; A set of burden multipliers that's maintained for use across projects. Also referred to as a standard burden schedule.
    • CalendarType; string; The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information.
    • CurrentPlanningPeriod; string; Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value isn't applicable when the calendar type is set to NONE.
    • DateTypeForConversionInPC; string; Date type that's used as a cost conversion attribute for project currency.
    • DateTypeForConversionInPLC; string; Date type that's used as a cost conversion attribute for project ledger currency.
    • DateTypeForCostConversion; string; Date type that's used as a cost conversion attribute for planning currencies.
    • EnableCostsForPlanFlag; boolean; Indicates whether resource assignments can be created on the project and allow capturing costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • EstimateToCompleteMethod; string; Calculates estimate-to-complete value for the task and task assignment. The valid values are Remaining Plan and Manual Entry.
    • FixedDateForConversionInPC; string; The date that's used to derive conversion rates for calculating planned costs for project currency.
    • FixedDateForConversionInPLC; string; The date that's used to derive conversion rates for calculating planned costs for project ledger currency.
    • FixedDateForCostConversion; string; The date that's used to derive conversion rates for calculating planned costs for planning currencies.
    • ForecastFinancialPlanType; string; The name of the financial plan type that's used to create the forecast version.
    • JobCostOptions; string; Rate schedule used for the calculation of cost amounts for jobs.
    • MaintainManualSpreadOnDateChanges; string; Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • MultipleTransactionCurrencies; string; Indicates that the plan can use multiple transaction currencies for planning. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • NonlaborResourceCostOptions; string; Rate schedule used for the calculation of cost amounts for non-labor resources.
    • PeriodProfile; string; Defines how time periods are grouped and displayed when editing resource assignment versions.
    • PersonCostOptions; string; Rate schedule used for the calculation of cost amounts for named persons.
    • PhysicalPercentCompleteCalculationMethod; string; Calculates physical percent complete at the lowest level task. The valid values are Cost, Effort, and Manual Entry.
    • PlanningOptionId; integer; Unique identifier of the summary level planning option in the financial project plan version.
    • PlanningResourceBreakdownStructure; string; Primary planning resource breakdown structure associated with the project.
    • PrimaryPhysicalPercentCompleteBasis; string; Determines the primary physical percent complete value for summary tasks. The valid values are Cost, Effort, and Manual Entry.
    • ProjectCurrency; string; Currency for the project.
    • ProjectLedgerCurrency; string; Project ledger currency for the project.
    • ProjectRoleCostOptions; string; Rate schedule used for the calculation of cost amounts for project role.
    • RateDerivationDate; string; The date that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
    • RateDerivationDateType; string; The date type, such as system date or fixed date, that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
    • RateTypeForConversionInPC; string; Rate type that's used as a cost conversion attribute for project currency.
    • RateTypeForConversionInPLC; string; Rate type that's used as a cost conversion attribute for project ledger currency.
    • RateTypeForCostConversion; string; Rate type that's used as a cost conversion attribute for planning currencies.
    • ResourceClassCostOptions; string; Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
    • RollUpTaskDatesFlag; boolean; Indicates whether summary task dates are rolled up from the lowest level task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • SetUnplannedAssignmentsAsPlannedAssignmentsFlag; boolean; Indicates whether resource assignments can be created as planned on the project on incurring costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag; boolean; Indicates whether task transaction dates are synchronized with task planned dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • ThirdPartySchedulingFlag; boolean; Indicates that the plan can use a third-party scheduling tool. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • UpdatePlannedQuantityWithEACQuantityFlag; boolean; Indicates whether planned values for task assignments can be updated with estimate-at-completion values while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
    • UsePlanningRatesFlag; boolean; Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts.
    • UseSameDatesForTaskAssignmentsAsTaskDatesFlag; boolean; Indicates whether you can use the same dates for the task assignments as the task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • 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 : financialProjectPlans-PlanningOptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : financialProjectPlans-PlanningOptions-item-response
Type: object
Show Source
  • Title: Allow Negative ETC Calculation
    Maximum Length: 1
    Indicates whether estimate-to-complete values can be lesser than zero. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Associate project costs to summary task assignments
    Maximum Length: 1
    Indicates whether project costs for a resource assignment from a lowest level task can be associated to a planned resource assignment on the financial project plan at a higher level in the task structure. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Automatically approve forecast
    Maximum Length: 1
    Indicates if the forecast that's created using the financial plan type is automatically approved.
  • Title: Automatically designate budget version as baseline
    Maximum Length: 1
    Indicates if the budget that's created using the financial plan type is automatically set to baseline.
  • Title: Automatically Generate Budget Version
    Maximum Length: 1
    Indicates if a budget is being created using the financial plan type while baseline of the financial project plan. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Automatically generate forecast version
    Maximum Length: 1
    Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Budget Financial Plan Type
    Read Only: true
    Maximum Length: 255
    The name of the financial plan type that's used to create the budget version.
  • Title: Buffer for Synchronize Task Transaction Dates with Task Planned Dates
    Buffer value to adjust the task transaction dates to be changed along with the task planned dates.
  • Title: Burden Schedule
    Maximum Length: 255
    A set of burden multipliers that's maintained for use across projects. Also referred to as a standard burden schedule.
  • Title: Calendar Type
    Maximum Length: 255
    The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information.
  • Title: Current Planning Period
    Maximum Length: 15
    Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value isn't applicable when the calendar type is set to NONE.
  • Title: Project Currency Conversion: Cost Date Type
    Maximum Length: 255
    Date type that's used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Date Type
    Maximum Length: 255
    Date type that's used as a cost conversion attribute for project ledger currency.
  • Title: Date Type for Cost Conversion
    Maximum Length: 255
    Date type that's used as a cost conversion attribute for planning currencies.
  • Title: Enable Costs for Plan
    Maximum Length: 1
    Indicates whether resource assignments can be created on the project and allow capturing costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Estimate to Complete Method
    Maximum Length: 30
    Calculates estimate-to-complete value for the task and task assignment. The valid values are Remaining Plan and Manual Entry.
  • Title: Project Currency Conversion: Cost Fixed Date
    The date that's used to derive conversion rates for calculating planned costs for project currency.
  • Title: Project Ledger Currency Conversion: Cost Fixed Date
    The date that's used to derive conversion rates for calculating planned costs for project ledger currency.
  • Title: Fixed Date for Cost Conversion
    The date that's used to derive conversion rates for calculating planned costs for planning currencies.
  • Title: Forecast Financial Plan Type
    Read Only: true
    Maximum Length: 255
    The name of the financial plan type that's used to create the forecast version.
  • Title: Job Cost Options
    Read Only: true
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for jobs.
  • Links
  • Title: Maintain manual spread on date changes
    Maximum Length: 1
    Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Multiple Transaction Currencies
    Maximum Length: 1
    Indicates that the plan can use multiple transaction currencies for planning. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Nonlabor Resource
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for non-labor resources.
  • Title: Period Profile
    Maximum Length: 255
    Defines how time periods are grouped and displayed when editing resource assignment versions.
  • Title: Person Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for named persons.
  • Title: Physical Percent Complete Calculation Method
    Maximum Length: 30
    Calculates physical percent complete at the lowest level task. The valid values are Cost, Effort, and Manual Entry.
  • Planning Currencies
    Title: Planning Currencies
    The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
  • Title: Planning Option ID
    Unique identifier of the summary level planning option in the financial project plan version.
  • Planning Options Descriptive Flexfields
    Title: Planning Options Descriptive Flexfields
    A listing of all the descriptive flexfields available for planning options in the financial project plan version.
  • Title: Planning Resource Breakdown Structure
    Maximum Length: 255
    Primary planning resource breakdown structure associated with the project.
  • Title: Primary Physical Percent Complete Basis
    Maximum Length: 30
    Determines the primary physical percent complete value for summary tasks. The valid values are Cost, Effort, and Manual Entry.
  • Title: Project Currency
    Read Only: true
    Maximum Length: 15
    Currency for the project.
  • Title: Project Ledger Currency
    Read Only: true
    Maximum Length: 15
    Project ledger currency for the project.
  • Title: Project Role Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for project role.
  • Title: Rate Derivation Date
    The date that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
  • Title: Rate Derivation Date Type
    Maximum Length: 255
    The date type, such as system date or fixed date, that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
  • Title: Project Currency Conversion: Cost Rate Type
    Maximum Length: 255
    Rate type that's used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Rate Type
    Maximum Length: 255
    Rate type that's used as a cost conversion attribute for project ledger currency.
  • Title: Rate Type for Cost Conversion
    Maximum Length: 255
    Rate type that's used as a cost conversion attribute for planning currencies.
  • Title: Resource Class Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
  • Title: Roll Up Task Dates
    Maximum Length: 1
    Indicates whether summary task dates are rolled up from the lowest level task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Set unplanned assignments as planned assignments
    Maximum Length: 1
    Indicates whether resource assignments can be created as planned on the project on incurring costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Synchronize Task Transaction Dates with Task Planned Dates
    Maximum Length: 1
    Indicates whether task transaction dates are synchronized with task planned dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Third Party Scheduling
    Maximum Length: 1
    Indicates that the plan can use a third-party scheduling tool. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Update planned quantity with EAC quantity
    Maximum Length: 1
    Indicates whether planned values for task assignments can be updated with estimate-at-completion values while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
  • Title: Use Planning Rates
    Maximum Length: 1
    Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts.
  • Title: Use Same Conversion Attribute for All Currency Conversions
    Indicates whether you can use the same currency conversion attribute for all currencies.
  • Title: Use Same Dates for Task Assignments as Task Dates
    Maximum Length: 1
    Indicates whether you can use the same dates for the task assignments as the task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
Nested Schema : Planning Currencies
Type: array
Title: Planning Currencies
The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
Show Source
Nested Schema : Planning Options Descriptive Flexfields
Type: array
Title: Planning Options Descriptive Flexfields
A listing of all the descriptive flexfields available for planning options in the financial project plan version.
Show Source
Nested Schema : financialProjectPlans-PlanningOptions-PlanningCurrencies-item-response
Type: object
Show Source
Nested Schema : financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all planning options 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/planVersionId/child/PlanningOptions

Example of Response Body

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

{
"items": [
{
"PlanningOptionId": 100100099198334,
"MultipleTransactionCurrencies": "Y",
"ThirdPartySchedulingFlag": false,
"EnableCostsForPlanFlag": true,
"SetUnplannedAssignmentsAsPlannedAssignmentsFlag": null,
"AssociateProjectCostsToSummaryTaskAssignmentsFlag": null,
"PlanningResourceBreakdownStructure": "Research Services Non Centrally Controlled PRBS300100172449458",
"CalendarType": "Accounting calendar",
"RateDerivationDateType": null,
"RateDerivationDate": null,
"PeriodProfile": "Accounting Period",
"CurrentPlanningPeriod": "Oct-18",
"MaintainManualSpreadOnDateChanges": "N",
"UseSameDatesForTaskAssignmentsAsTaskDatesFlag": true,
"RollUpTaskDatesFlag": false,
"SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag": false,
"BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates": 0,
"ProjectCurrency": "USD",
"ProjectLedgerCurrency": "USD",
"UseSameConversionAttributeForAllCurrencyConversionsFlag": false,
"RateTypeForCostConversion": null,
"DateTypeForCostConversion": null,
"FixedDateForCostConversion": null,
"RateTypeForConversionInPC": "PRJ_Corporate",
"DateTypeForConversionInPC": "Start date of project plan line",
"FixedDateForConversionInPC": null,
"RateTypeForConversionInPLC": null,
"DateTypeForConversionInPLC": null,
"FixedDateForConversionInPLC": null,
"UsePlanningRatesFlag": true,
"BurdenScheduleCostOptions": "Planning Burden Schedule",
"PersonCostOptions": "Employee Planning Cost Rates",
"JobCostOptions": "Construction Job Planning Cost",
"NonlaborResourceCostOptions": "Nonlabor Planning Cost Rates",
"ResourceClassCostOptions": "Resource Class Cost Rates",
"ProjectRoleCostOptions": null,
"PhysicalPercentCompleteCalculationMethod": "Cost",
"EstimateToCompleteMethod": "Remaining plan",
"AllowNegativeETCCalculationFlag": false,
"UpdatePlannedQuantityWithEACQuantityFlag": false,
"AutomaticallyGenerateForecastVersionFlag": false,
"ForecastFinancialPlanType": null,
"AutoApproveFlag": false,
"PrimaryPhysicalPercentCompleteBasis": "Cost",
"AutomaticallyGenerateBudgetVersionFlag": false,
"BudgetFinancialPlanType": null,
"AutoBaselineFlag": false,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333/child/PlanningOptions/100100099198334",
"name": "PlanningOptions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333/child/PlanningOptions/100100099198334",
"name": "PlanningOptions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333",
"name": "financialProjectPlans",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333/child/PlanningOptions/100100099198334/child/PlanningCurrencies",
"name": "PlanningCurrencies",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333/child/PlanningOptions/100100099198334/child/PlanningOptionsDFF",
"name": "PlanningOptionsDFF",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/100100099198333/child/PlanningOptions",
"name": "PlanningOptions",
"kind": "collection"
}
]
}
Back to Top