Get all planning options
get
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions
Request
Path Parameters
- PlanVersionId(required): integer(int64) Identifier of the project budget version.
Query Parameters
- dependency: string 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> - 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
Finder Variables:- PlanningOptionId
- PrimaryKey
- 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:- AmountScale; string; The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000.
- AssignTaskResourceInSingleCurrencyFlag; boolean; Indicates whether a budget line is enabled for assigning resources in a single currency for a task.
- BillRateDerivationDate; string; The date that is used as the basis for deriving rates for calculating revenue amounts.
- BillRateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts.
- BurdenScheduleCostOptions; string; A set of burden multipliers that is 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.
- CostDateTypeForConversionInPC; string; Date type that is used as a cost conversion attribute for project currency.
- CostDateTypeForConversionInPLC; string; Date type that is used as a cost conversion attribute for project ledger currency.
- CostFixedDateForConversionInPC; string; The date that is used to derive rates for calculating planned costs for project currency.
- CostFixedDateForConversionInPLC; string; The date that is used to derive rates for calculating planned costs for project ledger currency.
- CostRateDerivationDate; string; The date that is used as the basis for deriving rates for calculating cost amounts.
- CostRateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts.
- CostRateTypeForConversionInPC; string; Cost rate type that is used as a cost conversion attribute for project currency.
- CostRateTypeForConversionInPLC; string; Cost rate type that is used as a cost conversion attribute for project ledger currency.
- CurrencyType; string; Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts.
- 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 is not applicable when the calendar type is set to NONE.
- DateTypeForCostConversion; string; Date type that is used as a cost conversion attribute for planning currencies.
- DateTypeForRevenueConversion; string; Date type that is used as a revenue conversion attribute for planning currencies.
- DefaultReportingOption; string; Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue.
- DesignateAsApprovedCostBudgetFlag; boolean; Indicates whether a financial plan type is an approved cost budget.
- DesignateAsApprovedRevenueBudgetFlag; boolean; Indicates whether a financial plan type is an approved revenue budget.
- EnableBudgetaryControls; string; Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
- FixedDateForCostConversion; string; The date that is used to derive rates for calculating planned costs for planning currencies.
- FixedDateForRevenueConversion; string; The date that is used to derive rates for calculating planned revenue for planning currencies.
- JobCostOptions; string; Rate schedule used for the calculation of cost amounts for jobs.
- JobRevenueOptions; string; Rate schedule used for the calculation of revenue 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 means that the attribute is not selected.
- MultipleTransactionCurrencies; string; Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
- NonlaborResourceCostOptions; string; Rate schedule used for the calculation of cost amounts for non-labor resources.
- NonlaborResourceRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for non-labor resources.
- PeriodProfile; string; Defines how time periods are grouped and displayed when editing budget versions.
- PersonCostOptions; string; Rate schedule used for the calculation of cost amounts for named persons.
- PersonRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for named persons.
- PlanningLevel; string; Level of the budget at which amounts can be entered.
- PlanningOptionId; integer; Unique identifier of the summary level planning option in the project budget version.
- PlanningResourceBreakdownStructure; string; Planning resource breakdown structure associated with the project.
- 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.
- ProjectRoleRevenueOptions; string; Rate schedule used for the calculation of cost amounts for project role.
- RateDerivationDate; string; The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
- RateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
- RateTypeForCostConversion; string; Cost rate type that is used as a cost conversion attribute for planning currencies.
- RateTypeForRevenueConversion; string; Revenue rate type that is used as a revenue conversion attribute for planning currencies.
- ReportCost; string; Determines the cost amount types that are used to calculate and report margins on budgets.
- 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.
- ResourceClassRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
- RetainOverrideRatesFromSourceFlag; boolean; Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version.
- RevenueDateTypeForConversionInPC; string; Date type that is used as a revenue conversion attribute for project currency.
- RevenueDateTypeForConversionInPLC; string; Date type that is used as a revenue conversion attribute for project ledger currency.
- RevenueFixedDateForConversionInPC; string; The date that is used to derive rates for calculating planned revenue for project currency.
- RevenueFixedDateForConversionInPLC; string; The date that is used to derive rates for calculating planned revenue for project ledger currency.
- RevenueGenerationMethod; string; Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.
- RevenueRateTypeForConversionInPC; string; Revenue rate type that is used as a revenue conversion attribute for project currency.
- RevenueRateTypeForConversionInPLC; string; Revenue rate type that is used as a revenue conversion attribute for project ledger currency.
- UsePlanningRatesFlag; boolean; Enables utilization of planning rates for resources and resource classes when calculating budget amounts.
- 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: string If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: string The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
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: 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.
Root Schema : projectBudgets-PlanningOptions
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 : projectBudgets-PlanningOptions-item-response
Type:
Show Source object
- AmountScale: string Title:
Amount Scale
Maximum Length:255
The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000. - AmountTypes: array Amount Types Title:
Amount Types
The Amount Type resource is used to select the cost and revenue items to include in a financial plan type. - AssignTaskResourceInSingleCurrencyFlag: boolean Title:
Assign Resource in Single Currency for a Task
Indicates whether a budget line is enabled for assigning resources in a single currency for a task. - BillRateDerivationDate: string (date-time) Title:
Bill Rate Derivation Date
The date that is used as the basis for deriving rates for calculating revenue amounts. - BillRateDerivationDateType: string Title:
Bill Rate Derivation Date Type
Maximum Length:255
The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts. - BudgetaryControlSettings: array Budgetary Control Settings Title:
Budgetary Control Settings
The Budgetary Control Setting resource is used to view and update project and top resource control levels. - BurdenScheduleCostOptions: string Title:
Burden Schedule
Maximum Length:255
A set of burden multipliers that is 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. - CostDateTypeForConversionInPC: string Title:
Project Currency Conversion: Cost Date Type
Maximum Length:255
Date type that is used as a cost conversion attribute for project currency. - CostDateTypeForConversionInPLC: string Title:
Project Ledger Currency Conversion: Cost Date Type
Maximum Length:255
Date type that is used as a cost conversion attribute for project ledger currency. - CostFixedDateForConversionInPC: string (date-time) Title:
Project Currency Conversion: Cost Fixed Date
The date that is used to derive rates for calculating planned costs for project currency. - CostFixedDateForConversionInPLC: string (date-time) Title:
Project Ledger Currency Conversion: Cost Fixed Date
The date that is used to derive rates for calculating planned costs for project ledger currency. - CostRateDerivationDate: string (date-time) Title:
Cost Rate Derivation Date
The date that is used as the basis for deriving rates for calculating cost amounts. - CostRateDerivationDateType: string Title:
Cost Rate Derivation Date Type
Maximum Length:255
The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts. - CostRateTypeForConversionInPC: string Title:
Project Currency Conversion: Cost Rate Type
Maximum Length:255
Cost rate type that is used as a cost conversion attribute for project currency. - CostRateTypeForConversionInPLC: string Title:
Project Ledger Currency Conversion: Cost Rate Type
Maximum Length:255
Cost rate type that is used as a cost conversion attribute for project ledger currency. - CurrencyType: string Title:
Currency Type
Maximum Length:255
Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts. - 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 is not applicable when the calendar type is set to NONE. - DateTypeForCostConversion: string Title:
Date Type for Cost Conversion
Maximum Length:255
Date type that is used as a cost conversion attribute for planning currencies. - DateTypeForRevenueConversion: string Title:
Date Type for Revenue Conversion
Maximum Length:255
Date type that is used as a revenue conversion attribute for planning currencies. - DefaultReportingOption: string Title:
Default Reporting Option
Read Only:true
Maximum Length:255
Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue. - DesignateAsApprovedCostBudgetFlag: boolean Title:
Designate as approved cost budget
Read Only:true
Indicates whether a financial plan type is an approved cost budget. - DesignateAsApprovedRevenueBudgetFlag: boolean Title:
Designate as approved revenue budget
Read Only:true
Indicates whether a financial plan type is an approved revenue budget. - EnableBudgetaryControls: string Title:
Enable Budgetary Controls
Read Only:true
Maximum Length:1
Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. - ExportOptions: array Export Options Title:
Export Options
The Export Option resource is used to select the planning options attributes to export. - FixedDateForCostConversion: string (date-time) Title:
Fixed Date for Cost Conversion
The date that is used to derive rates for calculating planned costs for planning currencies. - FixedDateForRevenueConversion: string (date-time) Title:
Fixed Date for Revenue Conversion
The date that is used to derive rates for calculating planned revenue for planning currencies. - JobCostOptions: string Title:
Job Cost Options
Maximum Length:255
Rate schedule used for the calculation of cost amounts for jobs. - JobRevenueOptions: string Title:
Job Revenue Options
Maximum Length:255
Rate schedule used for the calculation of revenue 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:255
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 means that the attribute is not selected. - MultipleTransactionCurrencies: string Title:
Multiple Transaction Currencies
Maximum Length:255
Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. - NonlaborResourceCostOptions: string Title:
Nonlabor Resource
Maximum Length:255
Rate schedule used for the calculation of cost amounts for non-labor resources. - NonlaborResourceRevenueOptions: string Title:
Nonlabor Resource
Maximum Length:255
Rate schedule used for the calculation of revenue amounts for non-labor resources. - PeriodProfile: string Title:
Period Profile
Maximum Length:255
Defines how time periods are grouped and displayed when editing budget versions. - PersonCostOptions: string Title:
Person Cost Options
Maximum Length:255
Rate schedule used for the calculation of cost amounts for named persons. - PersonRevenueOptions: string Title:
Person Revenue Options
Maximum Length:255
Rate schedule used for the calculation of revenue amounts for named persons. - PlanningCurrencies: array Planning Currencies Title:
Planning Currencies
The Planning Currency resource is used to view, create, update, and delete project and planning currencies. - PlanningLevel: string Title:
Planning Level
Maximum Length:255
Level of the budget at which amounts can be entered. - PlanningOptionId: integer (int64) Title:
Planning Option ID
Unique identifier of the summary level planning option in the project budget version. - PlanningOptionsDFF: array Planning Options Descriptive Flexfields Title:
Planning Options Descriptive Flexfields
A listing of all the descriptive flexfields available for planning options in project budget versions. - PlanningResourceBreakdownStructure: string Title:
Planning Resource Breakdown Structure
Maximum Length:255
Planning resource breakdown structure associated with the project. - 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. - ProjectRoleRevenueOptions: string Title:
Project Role Revenue 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 is used as the basis for deriving rates for calculating amounts on a none time phase budget version. - RateDerivationDateType: string Title:
Rate Derivation Date Type
Maximum Length:255
The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version. - RateTypeForCostConversion: string Title:
Rate Type for Cost Conversion
Maximum Length:255
Cost rate type that is used as a cost conversion attribute for planning currencies. - RateTypeForRevenueConversion: string Title:
Rate Type for Revenue Conversion
Maximum Length:255
Revenue rate type that is used as a revenue conversion attribute for planning currencies. - ReportCost: string Title:
Report Cost
Maximum Length:255
Determines the cost amount types that are used to calculate and report margins on budgets. - 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. - ResourceClassRevenueOptions: string Title:
Resource Class Revenue Options
Maximum Length:255
Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. - RetainOverrideRatesFromSourceFlag: boolean Title:
Retain override rates from source
Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version. - RevenueDateTypeForConversionInPC: string Title:
Project Currency Conversion: Revenue Date Type
Maximum Length:255
Date type that is used as a revenue conversion attribute for project currency. - RevenueDateTypeForConversionInPLC: string Title:
Project Ledger Currency Conversion: Revenue Date Type
Maximum Length:255
Date type that is used as a revenue conversion attribute for project ledger currency. - RevenueFixedDateForConversionInPC: string (date-time) Title:
Project Currency Conversion: Revenue Fixed Date
The date that is used to derive rates for calculating planned revenue for project currency. - RevenueFixedDateForConversionInPLC: string (date-time) Title:
Project Ledger Currency Conversion: Revenue Fixed Date
The date that is used to derive rates for calculating planned revenue for project ledger currency. - RevenueGenerationMethod: string Title:
Revenue Generation Method
Maximum Length:255
Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks. - RevenueRateTypeForConversionInPC: string Title:
Project Currency Conversion: Revenue Rate Type
Maximum Length:255
Revenue rate type that is used as a revenue conversion attribute for project currency. - RevenueRateTypeForConversionInPLC: string Title:
Project Ledger Currency Conversion: Revenue Rate Type
Maximum Length:255
Revenue rate type that is used as a revenue conversion attribute for project ledger currency. - UsePlanningRatesFlag: boolean Title:
Use Planning Rates
Enables utilization of planning rates for resources and resource classes when calculating budget 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.
Nested Schema : Amount Types
Type:
array
Title:
Amount Types
The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
Show Source Nested Schema : Budgetary Control Settings
Type:
array
Title:
Budgetary Control Settings
The Budgetary Control Setting resource is used to view and update project and top resource control levels.
Show Source Nested Schema : Export Options
Type:
array
Title:
Export Options
The Export Option resource is used to select the planning options attributes to export.
Show Source 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 project budget versions.
Show Source Nested Schema : projectBudgets-PlanningOptions-AmountTypes-item-response
Type:
Show Source object
- AmountTypeId: integer (int64) Title:
Amount Type ID
Identifier of the project budget version amoun types. - BillRateFlag: boolean Title:
Bill rate
Indicates whether the revenue rate is editable. - BurdenedCostFlag: boolean Title:
Burdened Cost
Indicates whether the burdened cost amounts for a budget version are editable. - BurdenedCostRateFlag: boolean Title:
Burdened Cost Rate
Indicates whether the burdened cost rate is editable. - links: array Links Title:
Links
The link relations associated with the resource instance. - QuantityFlag: boolean Title:
Quantity
Indicates whether the quantity for a budget version is editable. - RawCostFlag: boolean Title:
Raw Cost
Indicates whether the raw cost amounts for a budget version are editable. - RawCostRateFlag: boolean Title:
Raw Cost Rate
Indicates whether the raw cost rate is editable. - RevenueFlag: boolean Title:
Revenue
Indicates whether the revenue for a budget version is editable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response
Type:
Show Source object
- BudgetaryControlSettingId: integer (int64) Title:
Budgetary Control Setting ID
Identifier of the budgetary control settings for the project budget. - ControlBudget: string Title:
Control Budget
Maximum Length:255
Name of the control budget. - ControlLevel: string Title:
Control Level
Maximum Length:255
The budgetary control level for the budget version. - DefaultRateType: string Title:
Default Rate Type
Maximum Length:255
The default rate type for budgetary control for the budget version. - links: array Links Title:
Links
The link relations associated with the resource instance. - TolerancePercentage: number Title:
Tolerance Percentage
The budgetary control level tolerance percentage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectBudgets-PlanningOptions-ExportOptions-item-response
Type:
Show Source object
- BurdenedCostEffectiveMultiplier: string Title:
Burdened Cost: Effective Multiplier
Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - BurdenedCostStandardMultiplier: string Title:
Burdened Cost: Standard Multiplier
Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - BurdenedCostStandardRate: string Title:
Burdened Cost: Standard Rate
Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - DisplayRatesAndAmountsInMultipleTransactionCurrenciesFlag: boolean Title:
Display currency conversion attributes and amounts in multiple transaction currencies
Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies. - EffectiveBurdenedCostRate: string Title:
Burdened Cost: Effective Rate
User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - EffectiveRawCostRate: string Title:
Raw Cost: Effective Rate
User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - EffectiveRevenueRate: string Title:
Effective Revenue Rate
User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ExportOptionId: integer Title:
Export Options ID
Read Only:true
Identifier of the project budget version export options. - FromDate: string Title:
From Date
From date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - links: array Links Title:
Links
The link relations associated with the resource instance. - MarginPercentage: string Title:
Margin Percentage
Margin expressed as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - PlanningCurrency: string Title:
Planning Currency
Currency used for planning in the budget line. This value is always set to true and the attribute is exported. - PlanningResource: string Title:
Planning Resource
Resource used for financial planning in budgets. This value is always set to true and the attribute is exported. - ProjectCurrencyConversionCostDate: string Title:
Project Currency Conversion: Cost Date
Date that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionCostDateType: string Title:
Project Currency Conversion: Cost Date Type
Date type that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionCostRate: string Title:
Project Currency Conversion: Cost Rate
Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionCostRateType: string Title:
Project Currency Conversion: Cost Rate Type
The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionRevenueDate: string Title:
Project Currency Conversion: Revenue Date
Date that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionRevenueDateType: string Title:
Project Currency Conversion: Revenue Date Type
Date type that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionRevenueRate: string Title:
Project Currency Conversion: Revenue Rate
Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectCurrencyConversionRevenueRateType: string Title:
Project Currency Conversion: Revenue Rate Type
The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionCostDate: string Title:
Project Ledger Currency Conversion: Cost Date
Date that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionCostDateType: string Title:
Project Ledger Currency Conversion: Cost Date Type
Date type that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionCostRate: string Title:
Project Ledger Currency Conversion: Cost Rate
Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionCostRateType: string Title:
Project Ledger Currency Conversion: Cost Rate Type
The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionRevenueDate: string Title:
Project Ledger Currency Conversion: Revenue Date
Date that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionRevenueDateType: string Title:
Project Ledger Currency Conversion: Revenue Date Type
Date type that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionRevenueRate: string Title:
Project Ledger Currency Conversion: Revenue Rate
Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ProjectLedgerCurrencyConversionRevenueRateType: string Title:
Project Ledger Currency Conversion: Revenue Rate Type
The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - ResourceClass: string Title:
Resource Class
Resource class associated with the budget line. This value is always set to true and the attribute is exported. - SpreadCurve: string Title:
Spread Curve
Spread curve associated with the budget line. This value is always set to true and the attribute is exported. - StandardRawCostRate: string Title:
Raw Cost: Standard Rate
Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - StandardRevenueRate: string Title:
Revenue: Standard Rate
Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TaskName: string Title:
Task Name
Name assigned to a task. This value is always set to true and the attribute is exported. - TaskNumber: string Title:
Task Number
Number of the task. This value is always set to true and the attribute is exported. - ToDate: string Title:
To Date
End date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalBurdenedCost: string Title:
Burdened Cost: Total
Total burdened costs incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalBurdenedCostInProjectCurrency: string Title:
Burdened Cost in Project Currency: Total
Total burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalBurdenedCostInProjectLedgerCurrency: string Title:
Burdened Cost in Project Ledger Currency: Total
Total burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalMargin: string Title:
Total Margin
Total margin (difference between revenue and cost) in a project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalMarginInProjectCurrency: string Title:
Margin in Project Currency: Total
Total margin in the project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalMarginInProjectLedgerCurrency: string Title:
Margin in Project Ledger Currency: Total
Total margin in the project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalQuantity: string Title:
Quantity: Total
Total quantity of resource effort that's required to complete a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRawCost: string Title:
Raw Cost: Total
Total cost directly attributable to the work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRawCostInProjectCurrency: string Title:
Raw Cost in Project Currency: Total
Total raw costs that are directly attributable to the work performed in the current budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRawCostInProjectLedgerCurrency: string Title:
Raw Cost in Project Ledger Currency: Total
Total raw costs that are directly attributable to the work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRevenue: string Title:
Revenue: Total
Total planned revenue that's associated with the accounting period or a plan line in the budget. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRevenueInProjectCurrency: string Title:
Revenue in Project Currency: Total
Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - TotalRevenueInProjectLedgerCurrency: string Title:
Revenue in Project Ledger Currency: Total
Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. - UnitOfMeasure: string Title:
Unit of Measure
Read Only:true
Unit of measure for a resource. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectBudgets-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 : projectBudgets-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 project budget version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source