Get a plan component
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}
Request
Path Parameters
-
expressionDetailPlanComponentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Expression Detail Plan Components resource and used to uniquely identify an instance of Expression Detail Plan Components. The client should not generate the hash key value. Instead, the client should query on the Expression Detail Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Expression Detail Plan Components.
For example: expressionDetailPlanComponents?q=PlanComponentId=<value1>;OrgId=<value2> -
incentiveCompensationExpressionDetailItemsLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrgId and ExpressionDetailType ---for the Expression Detail Items resource and used to uniquely identify an instance of Expression Detail Items. The client should not generate the hash key value. Instead, the client should query on the Expression Detail Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Expression Detail Items.
For example: incentiveCompensationExpressionDetailItemsLOV?q=OrgId=<value1>;ExpressionDetailType=<value2>
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-item-response
Type:
Show Source
object
-
expressionDetailPlanComponentAttributes: array
Expression Detail Plan Component Attributes
Title:
Expression Detail Plan Component Attributes
The plan component attributes list of values resource is used to view the list of attributes of a plan component that can be used in an expression. -
ExpressionDetailTypeCode: string
Read Only:
true
Maximum Length:30
The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component. -
PlanComponentName: string
Title:
Plan Component
Read Only:true
Maximum Length:80
The name of the plan component.
Nested Schema : Expression Detail Plan Component Attributes
Type:
array
Title:
Expression Detail Plan Component Attributes
The plan component attributes list of values resource is used to view the list of attributes of a plan component that can be used in an expression.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-item-response
Type:
Show Source
object
-
AttributeConfigId: number
Read Only:
true
The unique identifier of the plan component's attribute. -
expressionDetailPlanComponentsMeasures: array
Expression Detail Plan Component Measures
Title:
Expression Detail Plan Component Measures
The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression. -
ExpressionDetailTypeCode: string
Read Only:
true
Maximum Length:30
The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component. -
PlanComponentName: string
Title:
Plan Component
Read Only:true
Maximum Length:80
The name of the plan component. -
PlanComponentResultAttribute: string
Title:
Plan Component Result Attribute
Read Only:true
Maximum Length:240
The attribute of the plan component.
Nested Schema : Expression Detail Plan Component Measures
Type:
array
Title:
Expression Detail Plan Component Measures
The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response
Type:
Show Source
object
-
expressionDetailPlanComponentsMeasureResultAttributes: array
Expression Detail Plan Component Measure Result Attributes
Title:
Expression Detail Plan Component Measure Result Attributes
The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression. -
ExpressionDetailTypeCode: string
Read Only:
true
Maximum Length:30
The code for the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. -
FormulaId: integer
(int64)
Read Only:
true
The unique identifier of the plan component's performance measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component. -
PlanComponentMeasureName: string
Title:
Performance Measure
Read Only:true
Maximum Length:80
The name of the plan component's performance measure. -
PlanComponentName: string
Title:
Plan Component
Read Only:true
Maximum Length:80
The name of the plan component. -
PlanComponentResultAttribute: string
Title:
Plan Component Result Attribute
Read Only:true
Maximum Length:23
The attribute of the plan component.
Nested Schema : Expression Detail Plan Component Measure Result Attributes
Type:
array
Title:
Expression Detail Plan Component Measure Result Attributes
The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response
Type:
Show Source
object
-
AttributeConfigId: integer
(int64)
Read Only:
true
The unique identifier of the plan component's performance measure attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit. -
PlanComponentMeasureResultAttribute: string
Title:
Plan Component Measure Result Attribute
Read Only:true
Maximum Length:60
The plan component's performance measure's attribute.
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.
Links
- expressionDetailPlanComponentAttributes
-
Parameters:
- expressionDetailPlanComponentsUniqID:
$request.path.expressionDetailPlanComponentsUniqID
- incentiveCompensationExpressionDetailItemsLOVUniqID:
$request.path.incentiveCompensationExpressionDetailItemsLOVUniqID
The plan component attributes list of values resource is used to view the list of attributes of a plan component that can be used in an expression. - expressionDetailPlanComponentsUniqID: