Get all export options settings for a project budget version
get
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions
Request
Path Parameters
-
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.
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:- ExportOptionId
- 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:- BurdenedCostEffectiveMultiplier; string; 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; 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; 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; 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; 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; 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; 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; Identifier of the project budget version export options.
- FromDate; string; 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; 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; Currency used for planning in the budget line. This value is always set to true and the attribute is exported.
- PlanningResource; string; Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.
- ProjectCurrencyConversionCostDate; string; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; Resource class associated with the budget line. This value is always set to true and the attribute is exported.
- SpreadCurve; string; Spread curve associated with the budget line. This value is always set to true and the attribute is exported.
- StandardRawCostRate; string; 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; 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; Name assigned to a task. This value is always set to true and the attribute is exported.
- TaskNumber; string; Number of the task. This value is always set to true and the attribute is exported.
- ToDate; string; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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; 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.
-
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 : projectBudgets-PlanningOptions-ExportOptions
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-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.