Get an expression detail item

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : incentiveCompensationExpressionDetailItemsLOV-item-response
Type: object
Show Source
Nested Schema : Expression Detail Basic Attribute Groups
Type: array
Title: Expression Detail Basic Attribute Groups
The basic attribute groups resource is used to view the primary attribute groups used in an expression.
Show Source
Nested Schema : Expression Detail Function Groups
Type: array
Title: Expression Detail Function Groups
The function groups resource is used to view the list of SQL functions groups based on the category of the functions they contain, that can be used in an expression.
Show Source
Nested Schema : Expression Detail Operators
Type: array
Title: Expression Detail Operators
The operators resource is used to view the list of mathematical operators that can be used in an expression.
Show Source
Nested Schema : Expression Detail Performance Measures
Type: array
Title: Expression Detail Performance Measures
The performance measures list of values resource is used to view the list of performance measures for which its attributes can be used in an expression.
Show Source
Nested Schema : Expression Detail Plan Components
Type: array
Title: Expression Detail Plan Components
The plan components list of values resource is used to view the list of plan components for which its attributes can be used in an expression.
Show Source
Nested Schema : Expression Detail User Defined Functions
Type: array
Title: Expression Detail User Defined Functions
The user defined functions list of values resource is used to view the list of predefined PL/SQL functions that can be used in an expression.
Show Source
Nested Schema : Expression Detail User Defined Query Value Sets
Type: array
Title: Expression Detail User Defined Query Value Sets
The user defined query value sets list of values resource is used to view the list of user defined queries which were created using table value sets. These user defined queries can be used in an expression.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-item-response
Type: object
Show Source
  • Title: Basic Attributes Group
    Read Only: true
    Maximum Length: 30
    The group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
  • Read Only: true
    Maximum Length: 30
    The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
  • Expression Detail Basic Attribute Names
    Title: Expression Detail Basic Attribute Names
    The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.
  • 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.
  • Title: Expression Type
    Read Only: true
    Maximum Length: 11
    The type of the expression. The default value is Calculation.
  • Links
  • Read Only: true
    The unique identifier of the business unit.
Nested Schema : Expression Detail Basic Attribute Names
Type: array
Title: Expression Detail Basic Attribute Names
The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-expressionDetailBasicAttributeNames-item-response
Type: object
Show Source
  • Title: Basic Attribute Column Name
    Read Only: true
    Maximum Length: 30
    The column within the table that the basic attribute refers to.
  • Read Only: true
    The unique identifier of the basic attribute used in an expression.
  • Title: Basic Attribute Name
    Read Only: true
    Maximum Length: 60
    The type or category of the entity used in an expression. A list of accepted values are listed in the meaning column of lookup codes in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.
  • Read Only: true
    Maximum Length: 30
    The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
  • Title: Basic Attribute Table Name
    Read Only: true
    Maximum Length: 30
    The table name that the basic attribute refers to.
  • 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.
  • Title: Expression Type
    Read Only: true
    Maximum Length: 11
    The type of the expression. Default value is Calculation.
  • Links
  • Read Only: true
    The unique identifier of the business unit.
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailFunctionGroups-item-response
Type: object
Show Source
  • Expression Detail Function Names
    Title: Expression Detail Function Names
    The function names resource is used to view the list of SQL functions within a specific function group that can be used in an expression.
  • 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.
  • Title: Functions Group
    Read Only: true
    Maximum Length: 30
    The group or category of the SQL functions used in an expression. A list of accepted values are listed in the lookup type CN_FUNCTION_TYPES.
  • Read Only: true
    Maximum Length: 30
    The code indicating the group or category of the SQL functions used in an expression. A list of accepted values are listed in the lookup type CN_FUNCTION_TYPES.
  • Links
  • Read Only: true
    Maximum Length: 30
    The lookup type which categorizes the SQL function. Default value is CN_FUNCTION_TYPES.
  • Read Only: true
    The unique identifier of the business unit.
Nested Schema : Expression Detail Function Names
Type: array
Title: Expression Detail Function Names
The function names resource is used to view the list of SQL functions within a specific function group that can be used in an expression.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailFunctionGroups-expressionDetailFunctionNames-item-response
Type: object
Show Source
  • 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.
  • Read Only: true
    Maximum Length: 30
    The code indicating the function within a function group, that is used in an expression. A list of acceptable values can be found by querying the corresponding function group as a lookup type.
  • Read Only: true
    Maximum Length: 30
    The code indicating the group or category of the SQL functions used in an expression. A list of accepted values are listed in the lookup type CN_FUNCTION_TYPES.
  • Title: Function Name
    Read Only: true
    Maximum Length: 80
    The name of the function within a function group, that is used in an expression. A list of acceptable values can be found by querying the corresponding function group as a lookup type.
  • Links
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailOperators-item-response
Type: object
Show Source
  • 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.
  • Title: Operator
    Read Only: true
    Maximum Length: 255
    The mathematical operator used in an expression.
  • Links
  • Read Only: true
    The unique identifier of the business unit.
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPerformanceMeasures-item-response
Type: object
Show Source
Nested Schema : Expression Detail Performance Measure Attributes
Type: array
Title: Expression Detail Performance Measure Attributes
The performance measure attributes list of values resource is used to view the list of attributes of a performance measure, that can be used in an expression.
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPerformanceMeasures-expressionDetailPerformanceMeasureAttributes-item-response
Type: object
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-item-response
Type: object
Show Source
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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-item-response
Type: object
Show Source
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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response
Type: object
Show Source
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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response
Type: object
Show Source
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-expressionDetailUserDefinedFunctions-item-response
Type: object
Show Source
  • 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
  • Read Only: true
    The unique identifier of the business unit.
  • Read Only: true
    Maximum Length: 30
    The group or category that the predefined functions belong to.
  • Title: User-Defined Function Name
    Read Only: true
    Maximum Length: 80
    The name of the predefined PL/SQL function. A list of accepted values are listed in the lookup type CN_USER_FUNCTIONS.
  • Read Only: true
    Maximum Length: 30
    The lookup code pertaining to the predefined PL/SQL function. A list of accepted values are listed in the lookup type CN_USER_FUNCTIONS.
Nested Schema : incentiveCompensationExpressionDetailItemsLOV-ExpressionDetailUserDefinedQueryValueSets-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    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
  • Read Only: true
    Maximum Length: 30
    The code indicating the user defined query using a value set. A list of accepted values are listed in the lookup type ORA_CN_USR_DEFN_EXPRSN_VLE_SET.
  • Title: User-Defined Query Description
    Read Only: true
    Maximum Length: 240
    The name of the user defined query. A list of accepted values are listed in the lookup codes description column for lookup type ORA_CN_USR_DEFN_EXPRSN_VLE_SET.
  • Title: User-Defined Query
    Read Only: true
    Maximum Length: 80
    The name of the user defined query. A list of accepted values are listed in the lookup type ORA_CN_USR_DEFN_EXPRSN_VLE_SET.
  • Read Only: true
    Maximum Length: 60
    The code indicating the value set used in the user-defined query.
  • Read Only: true
    Maximum Length: 4000
    The where clause of the value set used in the user-defined query.
Back to Top