Jump to

• Request
• Response
• Examples

Update an expression

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the incentive compensation expression.
• ExpressionDetails: array Expression Details
  Title: Expression Details

  The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.
• ExpressionUsages: array Expression Usages
  Title: Expression Usages

  The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.
• Name: string
  Title: Name

  Maximum Length: 160

  The name for the expression.

{
    "type":"object",
    "properties":{
        "ExpressionUsages":{
            "title":"Expression Usages",
            "type":"array",
            "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the incentive compensation expression.",
            "nullable":true
        },
        "ExpressionDetails":{
            "title":"Expression Details",
            "type":"array",
            "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-patch-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name for the expression.",
            "nullable":false
        }
    }
}

Nested Schema : Expression Details

Type: array

Title: Expression Details

The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.

Show Source

• Array of: object schema

{
    "title":"Expression Details",
    "type":"array",
    "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-patch-request"
    }
}

Nested Schema : Expression Usages

Type: array

Title: Expression Usages

The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.

Show Source

• Array of: object incentiveCompensationExpressions-ExpressionUsages-item-patch-request

{
    "title":"Expression Usages",
    "type":"array",
    "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-patch-request"
    }
}

Nested 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.
• 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.
• 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"
            }
        },
        "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"
            }
        },
        "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
        }
    }
}

Nested Schema : incentiveCompensationExpressions-ExpressionUsages-item-patch-request

Type: object

Show Source

• ExpressionId: integer (int64)
  The unique identifier for the expression associated with a business unit.
• UsageCode: string
  Title: Usage

  Maximum Length: 30

  The lookup code that represents where the expression can be used, such as an input expression for a group by measure. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that represents where the expression can be used, such as an input expression for a group by measure. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression associated with a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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-item-response

Type: object

Show Source

• 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.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the incentive compensation expression.
• Expression: string (byte)
  Title: Rendered Expression

  Read Only: true

  The entire expression with all the expression components like operators, attributes, functions, etc. This is used primarily to display the entire expression.
• ExpressionDetails: array Expression Details
  Title: Expression Details

  The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.
• ExpressionId: integer (int64)
  The unique identifier of the expression.
• ExpressionType: string
  Title: Expression Type

  Read Only: true

  Maximum Length: 30

  Default Value: CALCULATION

  The type of the expression. Possible values include CALCULATION and PAYMENT. The default value is CALCULATION. A list of acceptable values is defined in the lookup CN_EXPRESSION_TYPES. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ExpressionUsages: array Expression Usages
  Title: Expression Usages

  The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid 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.
• Name: string
  Title: Name

  Maximum Length: 160

  The name for the expression.
• OrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: INVALID

  Indicates the status of the expression, such as invalid or valid and ready for use. The default value is INVALID. A list of acceptable values is defined in the lookup CN_EXPRESSION_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the expression, such as invalid or valid and ready for use. The default value is INVALID. A list of acceptable values is defined in the lookup CN_EXPRESSION_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"INVALID",
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "ExpressionUsages":{
            "title":"Expression Usages",
            "type":"array",
            "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the incentive compensation expression.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionDetails":{
            "title":"Expression Details",
            "type":"array",
            "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name for the expression.",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Expression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"The entire expression with all the expression components like operators, attributes, functions, etc. This is used primarily to display the entire expression.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionType":{
            "title":"Expression Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the expression. Possible values include CALCULATION and PAYMENT. The default value is CALCULATION. A list of acceptable values is defined in the lookup CN_EXPRESSION_TYPES. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"CALCULATION",
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier of the expression.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Expression Details

Type: array

Title: Expression Details

The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.

Show Source

• Array of: object incentiveCompensationExpressions-ExpressionDetails-item-response

{
    "title":"Expression Details",
    "type":"array",
    "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-response"
    }
}

Nested Schema : Expression Usages

Type: array

Title: Expression Usages

The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.

Show Source

• Array of: object incentiveCompensationExpressions-ExpressionUsages-item-response

{
    "title":"Expression Usages",
    "type":"array",
    "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-response"
    }
}

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 : 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."
        }
    }
}

Nested Schema : incentiveCompensationExpressions-ExpressionUsages-item-response

Type: object

Show Source

• 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.
• ExpressionId: integer (int64)
  The unique identifier for the expression associated with a business unit.
• ExpressionName: string
  Title: Name

  Read Only: true

  Maximum Length: 160

  The name of the expression.
• ExpressionUsageId: integer (int64)
  The unique identifier for the expression usage.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date 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.
• UsageCode: string
  Title: Usage

  Maximum Length: 30

  The lookup code that represents where the expression can be used, such as an input expression for a group by measure. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• UsageName: string
  Title: Usage

  Read Only: true

  Maximum Length: 80

  The usage record that tells the user where the expression can be used correctly. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "UsageCode":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that represents where the expression can be used, such as an input expression for a group by measure. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionUsageId":{
            "type":"integer",
            "description":"The unique identifier for the expression usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ExpressionName":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageName":{
            "title":"Usage",
            "maxLength":"80",
            "type":"string",
            "description":"The usage record that tells the user where the expression can be used correctly.  A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression associated with a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Links

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The unique identifier of the business unit.

The following properties are defined on the LOV link relation:

• Source Attribute: OrgId; Target Attribute: OrganizationId
• Display Attribute: Name

CnLookupExpressionStatusVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_EXPRESSION_STATUS

The list of values indicating the status of the expression, such as invalid, or valid and ready for use. The default value is INVALID.

The following properties are defined on the LOV link relation:

• Source Attribute: Status; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupExpressionTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_EXPRESSION_TYPES

The list of values indicating the type of the expression, such as for calculation or payment. Possible values include CALCULATION and PAYMENT. The default value is CALCULATION.

The following properties are defined on the LOV link relation:

• Source Attribute: ExpressionType; Target Attribute: LookupCode
• Display Attribute: Meaning

ExpressionDetails

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

Parameters:

• incentiveCompensationExpressionsUniqID: $request.path.incentiveCompensationExpressionsUniqID

The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.

ExpressionUsages

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionUsages

Parameters:

• incentiveCompensationExpressionsUniqID: $request.path.incentiveCompensationExpressionsUniqID

The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.

Back to Top

Examples

The following example shows how to update an expression by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/00020000000EACED0005770800000000000000CC0000000EACED00057708000110F07F4E6716

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"Description" : "Expression for a credit amount."
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "Description" : "Expression for a credit amount.",
  "ExpressionType" : "CALCULATION",
  "OrgId" : 204,
  "ExpressionId" : 300100090750742,
  "Name" : "Credit Amount Expression",
  "Status" : "INVALID",
  "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate" : "2017-08-22T06:15:48-07:00",
  "LastUpdateDate" : "2017-08-22T06:20:09.053-07:00",
  "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin" : "575797B8081D23A2E0532DD6F00A5925",
  "links" : [ {
	...
	}
	]
}

Back to Top