Update an export option for a project budget version
patch
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}
Request
Path Parameters
- ExportOptionId(required): integer Identifier of the project budget version export options.
- PlanVersionId(required): integer(int64) Identifier of the project budget version.
- PlanningOptionId(required): integer(int64) Unique identifier of the summary level planning option in the project budget version.
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.
Supported Media Types
- application/json
Root Schema : schema
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. - 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. - 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.
Response
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-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 : 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.