Jump to

• Request
• Response

Create an expression detail

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails

Request

Path Parameters

• incentiveCompensationExpressionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrgId and ExpressionId ---for the Incentive Compensation Expressions resource and used to uniquely identify an instance of Incentive Compensation Expressions. The client should not generate the hash key value. Instead, the client should query on the Incentive Compensation Expressions collection resource with a filter on the primary key values in order to navigate to a specific instance of Incentive Compensation Expressions.
  
  For example: incentiveCompensationExpressions?q=OrgId=<value1>;ExpressionId=<value2>

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BasicAttributeName: string
  The name of the primary object attribute used in the expression detail. It is used in conjunction with the Basic Attributes Group field. Use BasicAttributeNameVO to get the list of acceptable values.
• BasicAttributesGroup: string
  The category that represents the primary objects like participant, credit, plan component, measure, or plan used. The ExpressionDetailType attribute should be Primary object attribute before using this field. A list of acceptable values is defined in the lookup CN_EXPR_ATTR_MENU. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ConstantValue: string
  The value of the constant used in the expression. A constant could be a number or a string. The expression detail type attribute should be Constant before using this field.
• ExpressionDetailId: integer (int64)
  The unique identifier for the expression detail record.
• ExpressionDetailType: string
  The type of the web service expression, such as User defined query, Primary object attribute, Rate table rate, SQL expression function, Constant, Measure result, Plan component result, User defined function, and Math operator. A list of acceptable values is defined in the meaning of the look up values of lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ExpressionId: integer (int64)
  The unique identifier for the expression record.
• ExpressionOperator: string
  Title: Operator

  The mathematical operator used in the expression. The expression detail type attribute should be Mathematical Operator before using this field. Use ExpressionOperatorVO to get the list of acceptable values.
• FunctionName: string
  The SQL function used in the expression. Depending on the value of the FunctionsGroup attribute, a different lookup can be used to get a list of acceptable values. It is used in conjunction with the FunctionsGroup field. A list of acceptable values is defined in the lookup CN_ADV_FUNCTIONS, CN_AGGR_FUNCTIONS, ORA_CN_VAL_ST_AGGRGN_FUNCTIONS, CN_COMP_FUNCTIONS, CN_NULL_FUNCTIONS, CN_NUMB_FUNCTIONS, ORA_CN_TEXT_FUNCTIONS, ORA_CN_DATE_FUNCTIONS, and ORA_CN_LOGICAL_OPERATIONS. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• FunctionsGroup: string
  The type of SQL functions used in the expression, such as Advanced functions, Aggregate functions, Value Set Aggregate functions, Comparison functions, Null functions, Number functions, Text functions, Date functions, or Logical operations. Before using this field, the Expression Detail Type attribute value must be SQL Expression Function. A list of acceptable values is defined in the lookup CN_FUNCTION_TYPES. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ItemLabel: string
  Title: Label

  Maximum Length: 500

  The label is given to part of an expression to describe what that specific part does. Labels act like comments which make it easy to decipher different parts of the expression and the overall expression.
• MeasureName: string
  Title: Measure

  The name of the performance measure whose result is used in the expression. The expression detail type attribute should be Measure Result before using this field. Use MeasureNameVO to get the list of acceptable values.
• MeasureResultAttribute: string
  The nature of the result of the performance measure used in the expression. It is used in conjunction with the MeasureName field. Use MeasureResultAttributeVO to get the list of acceptable values.
• PlanComponentMeasureName: string
  The name of the plan component whose measure result is used in the expression. The PlanComponentResultAttribute attribute should be PlanComponentsMeasure before using this field. Use PlanComponentMeasureNameVO to get the list of acceptable values.
• PlanComponentMeasureResultAttribute: string
  The nature of the plan component's measure result used in the expression. It is used in conjunction with the PlanComponentMeasureName field. Use PlanComponentMeasureResultAttributeVO to get the list of acceptable values.
• PlanComponentName: string
  Title: Plan Component

  The name of the plan component whose result will be used in the expression. The expression detail type attribute should be Plan Component Result before using this field. Use PlanComponentNameVO to get the list of acceptable values.
• PlanComponentResultAttribute: string
  The nature of the result of the plan component used in the expression. It is used in conjunction with the PlanComponentName field. Use PlanComponentResultAttributeVO to get the list of acceptable values.
• Sequence: integer (int32)
  Title: Sequence

  The order of the expression detail record within the expression. This is provided by the user only during Create. Do ensure, this is provided sequentially as you would read the expression from left to right or else the expression will have a different meaning.
• UserDefinedFunctionName: string
  The name of the user defined functions used in expressions. The expression detail type attribute should be User defined function before using this field. A list of acceptable values is defined in the lookup CN_USER_FUNCTIONS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• UserDefinedQueryName: string
  The value set code or lookup code of the user defined queries used in expressions. Before using this field, the Expression Detail Type attribute value must be User Defined Query. A list of acceptable values is defined in the lookup ORA_CN_USR_DEFN_EXPRSN_VLE_SET. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "PlanComponentMeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the plan component's measure result used in the expression. It is used in conjunction with the PlanComponentMeasureName field. Use PlanComponentMeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MeasureName":{
            "title":"Measure",
            "type":"string",
            "description":"The name of the performance measure whose result is used in the expression. The expression detail type attribute should be Measure Result before using this field. Use MeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpressionDetailId":{
            "type":"integer",
            "description":"The unique identifier for the expression detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpressionDetailType":{
            "type":"string",
            "description":"The type of the web service expression, such as User defined query, Primary object attribute, Rate table rate, SQL expression function, Constant, Measure result, Plan component result, User defined function, and Math operator. A list of acceptable values is defined in the meaning of the look up values of lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the expression detail record within the expression. This is provided by the user only during Create. Do ensure, this is provided sequentially as you would read the expression from left to right or else the expression will have a different meaning.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PlanComponentMeasureName":{
            "type":"string",
            "description":"The name of the plan component whose measure result is used in the expression. The PlanComponentResultAttribute attribute should be PlanComponentsMeasure before using this field. Use PlanComponentMeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "ExpressionOperator":{
            "title":"Operator",
            "type":"string",
            "description":"The mathematical operator used in the expression. The expression detail type attribute should be Mathematical Operator before using this field. Use ExpressionOperatorVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FunctionName":{
            "type":"string",
            "description":"The SQL function used in the expression. Depending on the value of the FunctionsGroup attribute, a different lookup can be used to get a list of acceptable values. It is used in conjunction with the FunctionsGroup field. A list of acceptable values is defined in the lookup CN_ADV_FUNCTIONS, CN_AGGR_FUNCTIONS, ORA_CN_VAL_ST_AGGRGN_FUNCTIONS, CN_COMP_FUNCTIONS, CN_NULL_FUNCTIONS, CN_NUMB_FUNCTIONS, ORA_CN_TEXT_FUNCTIONS, ORA_CN_DATE_FUNCTIONS, and ORA_CN_LOGICAL_OPERATIONS. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserDefinedFunctionName":{
            "type":"string",
            "description":"The name of the user defined functions used in expressions. The expression detail type attribute should be User defined function before using this field. A list of acceptable values is defined in the lookup CN_USER_FUNCTIONS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserDefinedQueryName":{
            "type":"string",
            "description":"The value set code or lookup code of the user defined queries used in expressions. Before using this field, the Expression Detail Type attribute value must be User Defined Query. A list of acceptable values is defined in the lookup ORA_CN_USR_DEFN_EXPRSN_VLE_SET. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "FunctionsGroup":{
            "type":"string",
            "description":"The type of SQL functions used in the expression, such as Advanced functions, Aggregate functions, Value Set Aggregate functions, Comparison functions, Null functions, Number functions, Text functions, Date functions, or Logical operations. Before using this field, the Expression Detail Type attribute value must be SQL Expression Function. A list of acceptable values is defined in the lookup CN_FUNCTION_TYPES. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the plan component used in the expression. It is used in conjunction with the PlanComponentName field. Use PlanComponentResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "BasicAttributeName":{
            "type":"string",
            "description":"The name of the primary object attribute used in the expression detail. It is used in conjunction with the Basic Attributes Group field. Use BasicAttributeNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BasicAttributesGroup":{
            "type":"string",
            "description":"The category that represents the primary objects like participant, credit, plan component, measure, or plan used. The ExpressionDetailType attribute should be Primary object attribute before using this field. A list of acceptable values is defined in the lookup CN_EXPR_ATTR_MENU. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConstantValue":{
            "type":"string",
            "description":"The value of the constant used in the expression. A constant could be a number or a string. The expression detail type attribute should be Constant before using this field.",
            "nullable":true,
            "x-queryable":false
        },
        "MeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the performance measure used in the expression. It is used in conjunction with the MeasureName field. Use MeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureName"
                ]
            }
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "type":"string",
            "description":"The name of the plan component whose result will be used in the expression. The expression detail type attribute should be Plan Component Result before using this field. Use PlanComponentNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ExpressionDetailType"
                ]
            }
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemLabel":{
            "title":"Label",
            "maxLength":"500",
            "type":"string",
            "description":"The label is given to part of an expression to describe what that specific part does. Labels act like comments which make it easy to decipher different parts of the expression and the overall expression.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : incentiveCompensationExpressions-ExpressionDetails-item-response

Type: object

Show Source

• BasicAttributeName: string
  The name of the primary object attribute used in the expression detail. It is used in conjunction with the Basic Attributes Group field. Use BasicAttributeNameVO to get the list of acceptable values.
• BasicAttributesGroup: string
  The category that represents the primary objects like participant, credit, plan component, measure, or plan used. The ExpressionDetailType attribute should be Primary object attribute before using this field. A list of acceptable values is defined in the lookup CN_EXPR_ATTR_MENU. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ConstantValue: string
  The value of the constant used in the expression. A constant could be a number or a string. The expression detail type attribute should be Constant before using this field.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DisplayValue: string
  Title: Display Value

  Read Only: true

  Maximum Length: 160

  The display value of the expression detail record.
• ExpressionDetailId: integer (int64)
  The unique identifier for the expression detail record.
• ExpressionDetailType: string
  The type of the web service expression, such as User defined query, Primary object attribute, Rate table rate, SQL expression function, Constant, Measure result, Plan component result, User defined function, and Math operator. A list of acceptable values is defined in the meaning of the look up values of lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ExpressionId: integer (int64)
  The unique identifier for the expression record.
• ExpressionOperator: string
  Title: Operator

  The mathematical operator used in the expression. The expression detail type attribute should be Mathematical Operator before using this field. Use ExpressionOperatorVO to get the list of acceptable values.
• FunctionName: string
  The SQL function used in the expression. Depending on the value of the FunctionsGroup attribute, a different lookup can be used to get a list of acceptable values. It is used in conjunction with the FunctionsGroup field. A list of acceptable values is defined in the lookup CN_ADV_FUNCTIONS, CN_AGGR_FUNCTIONS, ORA_CN_VAL_ST_AGGRGN_FUNCTIONS, CN_COMP_FUNCTIONS, CN_NULL_FUNCTIONS, CN_NUMB_FUNCTIONS, ORA_CN_TEXT_FUNCTIONS, ORA_CN_DATE_FUNCTIONS, and ORA_CN_LOGICAL_OPERATIONS. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• FunctionsGroup: string
  The type of SQL functions used in the expression, such as Advanced functions, Aggregate functions, Value Set Aggregate functions, Comparison functions, Null functions, Number functions, Text functions, Date functions, or Logical operations. Before using this field, the Expression Detail Type attribute value must be SQL Expression Function. A list of acceptable values is defined in the lookup CN_FUNCTION_TYPES. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ItemLabel: string
  Title: Label

  Maximum Length: 500

  The label is given to part of an expression to describe what that specific part does. Labels act like comments which make it easy to decipher different parts of the expression and the overall expression.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureName: string
  Title: Measure

  The name of the performance measure whose result is used in the expression. The expression detail type attribute should be Measure Result before using this field. Use MeasureNameVO to get the list of acceptable values.
• MeasureResultAttribute: string
  The nature of the result of the performance measure used in the expression. It is used in conjunction with the MeasureName field. Use MeasureResultAttributeVO to get the list of acceptable values.
• PlanComponentMeasureName: string
  The name of the plan component whose measure result is used in the expression. The PlanComponentResultAttribute attribute should be PlanComponentsMeasure before using this field. Use PlanComponentMeasureNameVO to get the list of acceptable values.
• PlanComponentMeasureResultAttribute: string
  The nature of the plan component's measure result used in the expression. It is used in conjunction with the PlanComponentMeasureName field. Use PlanComponentMeasureResultAttributeVO to get the list of acceptable values.
• PlanComponentName: string
  Title: Plan Component

  The name of the plan component whose result will be used in the expression. The expression detail type attribute should be Plan Component Result before using this field. Use PlanComponentNameVO to get the list of acceptable values.
• PlanComponentResultAttribute: string
  The nature of the result of the plan component used in the expression. It is used in conjunction with the PlanComponentName field. Use PlanComponentResultAttributeVO to get the list of acceptable values.
• Sequence: integer (int32)
  Title: Sequence

  The order of the expression detail record within the expression. This is provided by the user only during Create. Do ensure, this is provided sequentially as you would read the expression from left to right or else the expression will have a different meaning.
• UserDefinedFunctionName: string
  The name of the user defined functions used in expressions. The expression detail type attribute should be User defined function before using this field. A list of acceptable values is defined in the lookup CN_USER_FUNCTIONS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• UserDefinedQueryName: string
  The value set code or lookup code of the user defined queries used in expressions. Before using this field, the Expression Detail Type attribute value must be User Defined Query. A list of acceptable values is defined in the lookup ORA_CN_USR_DEFN_EXPRSN_VLE_SET. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionDetailType":{
            "type":"string",
            "description":"The type of the web service expression, such as User defined query, Primary object attribute, Rate table rate, SQL expression function, Constant, Measure result, Plan component result, User defined function, and Math operator. A list of acceptable values is defined in the meaning of the look up values of lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpressionOperator":{
            "title":"Operator",
            "type":"string",
            "description":"The mathematical operator used in the expression. The expression detail type attribute should be Mathematical Operator before using this field. Use ExpressionOperatorVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FunctionName":{
            "type":"string",
            "description":"The SQL function used in the expression. Depending on the value of the FunctionsGroup attribute, a different lookup can be used to get a list of acceptable values. It is used in conjunction with the FunctionsGroup field. A list of acceptable values is defined in the lookup CN_ADV_FUNCTIONS, CN_AGGR_FUNCTIONS, ORA_CN_VAL_ST_AGGRGN_FUNCTIONS, CN_COMP_FUNCTIONS, CN_NULL_FUNCTIONS, CN_NUMB_FUNCTIONS, ORA_CN_TEXT_FUNCTIONS, ORA_CN_DATE_FUNCTIONS, and ORA_CN_LOGICAL_OPERATIONS. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserDefinedQueryName":{
            "type":"string",
            "description":"The value set code or lookup code of the user defined queries used in expressions. Before using this field, the Expression Detail Type attribute value must be User Defined Query. A list of acceptable values is defined in the lookup ORA_CN_USR_DEFN_EXPRSN_VLE_SET. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "FunctionsGroup":{
            "type":"string",
            "description":"The type of SQL functions used in the expression, such as Advanced functions, Aggregate functions, Value Set Aggregate functions, Comparison functions, Null functions, Number functions, Text functions, Date functions, or Logical operations. Before using this field, the Expression Detail Type attribute value must be SQL Expression Function. A list of acceptable values is defined in the lookup CN_FUNCTION_TYPES. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the plan component used in the expression. It is used in conjunction with the PlanComponentName field. Use PlanComponentResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "BasicAttributeName":{
            "type":"string",
            "description":"The name of the primary object attribute used in the expression detail. It is used in conjunction with the Basic Attributes Group field. Use BasicAttributeNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentMeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the plan component's measure result used in the expression. It is used in conjunction with the PlanComponentMeasureName field. Use PlanComponentMeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayValue":{
            "title":"Display Value",
            "maxLength":"160",
            "type":"string",
            "description":"The display value of the expression detail record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureName":{
            "title":"Measure",
            "type":"string",
            "description":"The name of the performance measure whose result is used in the expression. The expression detail type attribute should be Measure Result before using this field. Use MeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpressionDetailId":{
            "type":"integer",
            "description":"The unique identifier for the expression detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the expression detail record within the expression. This is provided by the user only during Create. Do ensure, this is provided sequentially as you would read the expression from left to right or else the expression will have a different meaning.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PlanComponentMeasureName":{
            "type":"string",
            "description":"The name of the plan component whose measure result is used in the expression. The PlanComponentResultAttribute attribute should be PlanComponentsMeasure before using this field. Use PlanComponentMeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "UserDefinedFunctionName":{
            "type":"string",
            "description":"The name of the user defined functions used in expressions. The expression detail type attribute should be User defined function before using this field. A list of acceptable values is defined in the lookup CN_USER_FUNCTIONS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BasicAttributesGroup":{
            "type":"string",
            "description":"The category that represents the primary objects like participant, credit, plan component, measure, or plan used. The ExpressionDetailType attribute should be Primary object attribute before using this field. A list of acceptable values is defined in the lookup CN_EXPR_ATTR_MENU. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConstantValue":{
            "type":"string",
            "description":"The value of the constant used in the expression. A constant could be a number or a string. The expression detail type attribute should be Constant before using this field.",
            "nullable":true,
            "x-queryable":false
        },
        "MeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the performance measure used in the expression. It is used in conjunction with the MeasureName field. Use MeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureName"
                ]
            }
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "type":"string",
            "description":"The name of the plan component whose result will be used in the expression. The expression detail type attribute should be Plan Component Result before using this field. Use PlanComponentNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ExpressionDetailType"
                ]
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLabel":{
            "title":"Label",
            "maxLength":"500",
            "type":"string",
            "description":"The label is given to part of an expression to describe what that specific part does. Labels act like comments which make it easy to decipher different parts of the expression and the overall expression.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ExpressionDetailTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV

The list of values containing the types of each web service expression component. Examples include primary object attributes, constant, rate table rate, seeded or user defined functions, plan component or measure, name, and operators.

The following properties are defined on the LOV link relation:

• Source Attribute: ExpressionDetailType; Target Attribute: ExpressionDetailType
• Display Attribute: ExpressionDetailType, OrgId

Back to Top