Get all financial project plan versions
get
/fscmRestApi/resources/11.13.18.05/financialProjectPlans
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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: Finds the financial project plan version.
Finder Variables:- PlanVersionId; integer; Identifier of the financial project plan version.
- PrimaryKey: Finds the financial project plan version.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- BaselineBurdenedCostInProjectCurrency; number; Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version.
- BaselineBurdenedCostInProjectLedgerCurrency; number; Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
- BaselineEffort; number; Measure of the effort planned in the baseline financial project plan version, expressed in hours.
- BaselineRawCostInProjectCurrency; number; Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed.
- BaselineRawCostInProjectLedgerCurrency; number; Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed.
- BurdenedCostInProjectCurrency; number; Total planned cost for the project in project currency that includes both raw and burden costs.
- BurdenedCostInProjectLedgerCurrency; number; Total planned cost for the project in project ledger currency that includes both raw and burden costs.
- ITDActualBurdenedCostInProjectCurrency; number; Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date.
- ITDActualBurdenedCostInProjectLedgerCurrency; number; Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
- ITDActualEffort; number; Actual effort for the project from the start of the project till the current date, expressed in hours.
- ITDActualRawCostInProjectCurrency; number; Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date.
- ITDActualRawCostInProjectLedgerCurrency; number; Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
- PlanVersionId; integer; Identifier of the financial project plan version.
- PlanVersionStatus; string; Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed.
- PlannedEffort; number; Measure of the effort planned for in the financial project plan version, expressed in hours.
- ProjectId; integer; Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan.
- ProjectName; string; Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan.
- ProjectNumber; string; Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan.
- ProjectPlanType; string; Name of the project plan type from which the financial project plan is created.
- RawCostInProjectCurrency; number; Planned cost for the project in project currency that corresponds to the work performed.
- RawCostInProjectLedgerCurrency; number; Planned cost for the project in project ledger currency that corresponds to the work performed.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : financialProjectPlans
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-item-response
Type:
Show Source
object
-
BaselineBurdenedCostInProjectCurrency: number
Title:
Rolled-up Baseline Cost for Resource in Project Currency
Read Only:true
Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version. -
BaselineBurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version. -
BaselineEffort: number
Title:
Baseline
Read Only:true
Measure of the effort planned in the baseline financial project plan version, expressed in hours. -
BaselineRawCostInProjectCurrency: number
Title:
Rolled-up Baseline Cost for Resource in Project Currency
Read Only:true
Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed. -
BaselineRawCostInProjectLedgerCurrency: number
Title:
Baseline Cost in Project Ledger Currency
Read Only:true
Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed. -
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Total planned cost for the project in project currency that includes both raw and burden costs. -
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency: Total
Read Only:true
Total planned cost for the project in project ledger currency that includes both raw and burden costs. -
DeferProcessing: string
Title:
Defer Processing
Indicates that the financial project plan version will be managed in a deferred mode. -
ITDActualBurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date. -
ITDActualEffort: number
Title:
ITD Actual Effort
Read Only:true
Actual effort for the project from the start of the project till the current date, expressed in hours. -
ITDActualRawCostInProjectCurrency: number
Title:
ITD Actual in Project Currency
Read Only:true
Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlannedEffort: number
Title:
Project Plan Effort
Read Only:true
Measure of the effort planned for in the financial project plan version, expressed in hours. -
PlanningOptions: array
Planning Options
Title:
Planning Options
The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project. -
PlanVersionId: integer
(int64)
Title:
Plan Version
Identifier of the financial project plan version. -
PlanVersionStatus: string
Title:
Plan Version Status
Read Only:true
Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan. -
ProjectPlanType: string
Title:
Financial Plan Type
Read Only:true
Maximum Length:240
Name of the project plan type from which the financial project plan is created. -
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency: Total
Read Only:true
Planned cost for the project in project currency that corresponds to the work performed. -
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency: Total
Read Only:true
Planned cost for the project in project ledger currency that corresponds to the work performed. -
ResourceAssignments: array
Resource Assignments
Title:
Resource Assignments
The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment. -
VersionErrors: array
Plan Version Errors
Title:
Plan Version Errors
The Version Errors resource is used to view the errors in a financial project plan resource assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Options
Type:
array
Title:
Planning Options
The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.
Show Source
Nested Schema : Resource Assignments
Type:
array
Title:
Resource Assignments
The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.
Show Source
Nested Schema : Plan Version Errors
Type:
array
Title:
Plan Version Errors
The Version Errors resource is used to view the errors in a financial project plan resource assignment.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : financialProjectPlans-PlanningOptions-item-response
Type:
Show Source
object
-
AllowNegativeETCCalculationFlag: boolean
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. -
AssociateProjectCostsToSummaryTaskAssignmentsFlag: boolean
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. -
AutoApproveFlag: boolean
Title:
Automatically approve forecast
Maximum Length:1
Indicates if the forecast that's created using the financial plan type is automatically approved. -
AutoBaselineFlag: boolean
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. -
AutomaticallyGenerateBudgetVersionFlag: boolean
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. -
AutomaticallyGenerateForecastVersionFlag: boolean
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. -
BudgetFinancialPlanType: string
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. -
BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates: number
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. -
BurdenScheduleCostOptions: string
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. -
CalendarType: string
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. -
CurrentPlanningPeriod: string
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. -
DateTypeForConversionInPC: string
Title:
Project Currency Conversion: Cost Date Type
Maximum Length:255
Date type that's used as a cost conversion attribute for project currency. -
DateTypeForConversionInPLC: string
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. -
DateTypeForCostConversion: string
Title:
Date Type for Cost Conversion
Maximum Length:255
Date type that's used as a cost conversion attribute for planning currencies. -
EnableCostsForPlanFlag: boolean
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. -
EstimateToCompleteMethod: string
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. -
FixedDateForConversionInPC: string
(date-time)
Title:
Project Currency Conversion: Cost Fixed Date
The date that's used to derive conversion rates for calculating planned costs for project currency. -
FixedDateForConversionInPLC: string
(date-time)
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. -
FixedDateForCostConversion: string
(date-time)
Title:
Fixed Date for Cost Conversion
The date that's used to derive conversion rates for calculating planned costs for planning currencies. -
ForecastFinancialPlanType: string
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. -
JobCostOptions: string
Title:
Job Cost Options
Read Only:true
Maximum Length:255
Rate schedule used for the calculation of cost amounts for jobs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintainManualSpreadOnDateChanges: string
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. -
MultipleTransactionCurrencies: string
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. -
NonlaborResourceCostOptions: string
Title:
Nonlabor Resource
Maximum Length:255
Rate schedule used for the calculation of cost amounts for non-labor resources. -
PeriodProfile: string
Title:
Period Profile
Maximum Length:255
Defines how time periods are grouped and displayed when editing resource assignment versions. -
PersonCostOptions: string
Title:
Person Cost Options
Maximum Length:255
Rate schedule used for the calculation of cost amounts for named persons. -
PhysicalPercentCompleteCalculationMethod: string
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. -
PlanningCurrencies: array
Planning Currencies
Title:
Planning Currencies
The Planning Currency resource is used to view, create, update, and delete project and planning currencies. -
PlanningOptionId: integer
(int64)
Title:
Planning Option ID
Unique identifier of the summary level planning option in the financial project plan version. -
PlanningOptionsDFF: array
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. -
PlanningResourceBreakdownStructure: string
Title:
Planning Resource Breakdown Structure
Maximum Length:255
Primary planning resource breakdown structure associated with the project. -
PrimaryPhysicalPercentCompleteBasis: string
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. -
ProjectCurrency: string
Title:
Project Currency
Read Only:true
Maximum Length:15
Currency for the project. -
ProjectLedgerCurrency: string
Title:
Project Ledger Currency
Read Only:true
Maximum Length:15
Project ledger currency for the project. -
ProjectRoleCostOptions: string
Title:
Project Role Cost Options
Maximum Length:255
Rate schedule used for the calculation of cost amounts for project role. -
RateDerivationDate: string
(date-time)
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. -
RateDerivationDateType: string
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. -
RateTypeForConversionInPC: string
Title:
Project Currency Conversion: Cost Rate Type
Maximum Length:255
Rate type that's used as a cost conversion attribute for project currency. -
RateTypeForConversionInPLC: string
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. -
RateTypeForCostConversion: string
Title:
Rate Type for Cost Conversion
Maximum Length:255
Rate type that's used as a cost conversion attribute for planning currencies. -
ResourceClassCostOptions: string
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. -
RollUpTaskDatesFlag: boolean
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. -
SetUnplannedAssignmentsAsPlannedAssignmentsFlag: boolean
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. -
SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag: boolean
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. -
ThirdPartySchedulingFlag: boolean
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. -
UpdatePlannedQuantityWithEACQuantityFlag: boolean
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. -
UsePlanningRatesFlag: boolean
Title:
Use Planning Rates
Maximum Length:1
Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts. -
UseSameConversionAttributeForAllCurrencyConversionsFlag: boolean
Title:
Use Same Conversion Attribute for All Currency Conversions
Indicates whether you can use the same currency conversion attribute for all currencies. -
UseSameDatesForTaskAssignmentsAsTaskDatesFlag: boolean
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCurrencyCode: string
Title:
Planning Currency Code
Maximum Length:15
Currency code for the planning currency. -
PlanningCurrencyId: integer
(int64)
Title:
Planning Currency ID
Identifier of the planning currency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Code that identifies the context for the segments of the planning options flexfields. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Name of the context for the segments of the planning options flexfields. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningOptionId: integer
(int64)
Unique identifier of the summary level planning option in the financial project plan version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-item-response
Type:
Show Source
object
-
AdministrativeCode: string
Title:
Administrative Code
Action identifier used for administrative purpose only. -
BaselineFinishDate: string
(date-time)
Title:
Baseline Finish Date
Read Only:true
The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task. -
BaselineStartDate: string
(date-time)
Title:
Baseline Start Date
Read Only:true
The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintainManualSpreadOnDateChanges: string
Default Value:
N
Indicates whether the periodic planning is retained in the plan version on plan line date modifications. -
PlanningAmounts: array
Planning Amounts
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts. -
PlanningElementId: integer
(int64)
Identifier of the resource assignment on the financial project plan version.
-
PlanningFinishDate: string
(date-time)
Title:
Planning Dates: To Date
The date that is planned on the financial project plan for a resource to finish their assignment on a project task. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From Date
The date that is planned on the financial project plan for a resource to begin their assignment on a project task. -
RateBasedFlag: boolean
Title:
Rate-Based Planning Resource
Read Only:true
Indicates if the financial project plan resource assignment is rate based. -
RbsElementId: integer
(int64)
Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line.
-
ResourceClass: string
Read Only:
true
Maximum Length:240
Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources. -
ResourceName: string
Title:
Resource Name
Maximum Length:240
Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment. -
SpreadCurve: string
Title:
Spread Curve
Read Only:true
Maximum Length:240
Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment. -
TaskName: string
Title:
Task Name
Maximum Length:255
Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment. -
UnitOfMeasure: string
Title:
Name
Read Only:true
Maximum Length:80
Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment. -
UnplannedFlag: boolean
Title:
Unplanned
Maximum Length:1
Indicates if the financial project plan resource assignment is unplanned. -
UseTaskDatesAsTaskAssignmentDatesFlag: boolean
Title:
Use Task Planned Dates as Task Assignment Dates
Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response
Type:
Show Source
object
-
BaselineBurdenedCost: number
Title:
Baseline Burdened Cost
Read Only:true
Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency. -
BaselineBurdenedCostInProjectCurrency: number
Title:
Rolled-up Baseline Cost for Resource in Project Currency
Read Only:true
Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency. -
BaselineBurdenedCostInProjectLedgerCurrency: number
Title:
Baseline Burdened Cost
Read Only:true
Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version. -
BaselineCurrency: string
Title:
Baseline Currency
Read Only:true
Maximum Length:30
Currency of the rendered baseline amounts. -
BaselineQuantity: number
Title:
Baseline Quantity
Read Only:true
Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours. -
BaselineRawCost: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed. -
BaselineRawCostInProjectCurrency: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed. -
BaselineRawCostInProjectLedgerCurrency: number
Title:
Baseline Raw Cost
Read Only:true
Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
BurdenedCost: number
Title:
Burdened Cost
Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs. -
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs. -
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency: Total
Read Only:true
Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs. -
Currency: string
Title:
Currency
Maximum Length:15
Code that identifies the planning currency on the financial project plan resource assignment. -
EffectiveBurdenedCostRate: number
Title:
Average Effective Burden Cost Rate
Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. -
ITDActualBurdenedCost: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date. -
ITDActualQuantity: number
Title:
ITD Actual Quantity
Read Only:true
Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours. -
ITDActualRawCost: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectCurrency: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectLedgerCurrency: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PlanLineId: integer
(int64)
Title:
Plan Line ID
Identifier of the summary level planning amounts for a resource assignment in the financial project plan. -
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 financial project plans. -
PlannedQuantity: number
Title:
Planned Quantity
Measure of the effort planned for in the financial project plan resource assignment, expressed in hours. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts. -
RawCost: number
Title:
Raw Cost
Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed. -
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency: Total
Read Only:true
Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed. -
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 financial project plans.
Show Source
Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response
Type:
Show Source
object
-
__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 financial project plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object
-
BurdenedCost: number
Title:
Planned Burdened Cost
Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs. -
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency: Total
Read Only:true
Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs. -
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency: Total
Read Only:true
Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost Rate
Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. -
EffectiveRawCostRate: number
Title:
Effective Rate
Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. -
ITDActualBurdenedCost: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectCurrency: number
Title:
ITD Actual Burdened Cost
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date. -
ITDActualQuantity: number
Title:
ITD Actual Quantity
Read Only:true
Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours. -
ITDActualRawCost: number
Title:
ITD Actual Raw Cost
Read Only:true
Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectCurrency: number
Title:
ITD Actual in Project Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date. -
ITDActualRawCostInProjectLedgerCurrency: number
Title:
ITD Actual in Project Ledger Currency
Read Only:true
Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PeriodName: string
Title:
Period
Maximum Length:30
Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan. -
PlannedQuantity: number
Title:
Planned Quantity
Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours. -
RawCost: number
Title:
Raw cost
Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed. -
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency: Total
Read Only:true
Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed. -
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency: Total
Read Only:true
Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialProjectPlans-VersionErrors-item-response
Type:
Show Source
object
-
ErrorType: string
Title:
Rejection Type
Read Only:true
Maximum Length:30
Indicates the type of the exception, for example, Error or Warning. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageCause: string
Title:
Cause
Read Only:true
Maximum Length:4000
Reason due to which the error in the financial project version occurred. -
MessageName: string
Title:
Message Name
Read Only:true
Maximum Length:30
Name that identifies the message uniquely. -
MessageText: string
Title:
Message Text
Read Only:true
Maximum Length:240
Text of the message that indicates the cause and resolution of the error. -
MessageUserAction: string
Title:
Action
Read Only:true
Maximum Length:4000
The action that you must perform to resolve the error. -
MessageUserDetails: string
Title:
Additional Details
Read Only:true
Maximum Length:4000
Additional information about the cause and resolution of the error. -
PeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
Period for which errors exist in the financial project plan version. -
PlanVersionId: number
Title:
Plan Version
Read Only:true
Identifier of the financial project plan version. -
ResourceName: string
Title:
Resource
Read Only:true
Maximum Length:240
Name or alias name of the resource specified in the planning resource breakdown structure in the financial project plan version that has errors. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task in the financial project plan version that has errors. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number of the task in the financial project plan version that has errors. -
TransactionCurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
Code that identifies the planning currency in the financial project plan version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- adjustForRangeOfProjects
-
Adjusts the financial project plan versions for a range of projects using the adjustment type and adjustment percentage.
- baselineFinancialProjectPlan
-
Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineFinancialProjectPlanThis action will set the financial project plan to baseline. Additionally, you can create a budget version and baseline it.
- baselineRangeOfFinancialProjectPlans
-
Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineRangeOfFinancialProjectPlansSets the baseline financial project plan for a range of projects. Additionally, generates a budget version and baselines it based on the budget generation option specified in the project plan type settings.
- refreshRatesForRangeOfProjects
-
Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/refreshRatesForRangeOfProjectsRefresh rates on financial project plan versions for a range of projects.
- reprocessFailedFinancialProjectPlans
-
Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/reprocessFailedFinancialProjectPlansThis action will reprocess all the financial project plan versions that failed and places them back in the Current working state.
- updateActualAmountsForRangeOfProjects
-
Updates actual amounts for a range of projects.
- updatePlannedAmountsFromProgressForRangeOfProjects
-
Updates planned amounts from progress for a range of projects.
Examples
The following example shows how to get all financial project plan 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/financialProjectPlans
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "PlanVersionId": 4067307, "ProjectPlanType": "PSR Project Plan", "ProjectId": 100010025119098, "ProjectNumber": "PJO-M6MAT-PRJ8", "ProjectName": "PJO-M6MAT-PRJ8", "PlannedEffort": 22680, "ITDActualEffort": null, "BaselineEffort": null, "RawCostInProjectCurrency": 45360, "ITDActualRawCostInProjectCurrency": null, "BaselineRawCostInProjectCurrency": null, "BurdenedCostInProjectCurrency": 68040, "ITDActualBurdenedCostInProjectCurrency": null, "BaselineBurdenedCostInProjectCurrency": null, "RawCostInProjectLedgerCurrency": 45360, "ITDActualRawCostInProjectLedgerCurrency": null, "BaselineRawCostInProjectLedgerCurrency": null, "BurdenedCostInProjectLedgerCurrency": 68040, "ITDActualBurdenedCostInProjectLedgerCurrency": null, "BaselineBurdenedCostInProjectLedgerCurrency": null }