Create an expression
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Request
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
Root Schema : schema
Type:
Show Source
object
-
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. -
ExpressionId: integer
(int64)
The unique identifier of the expression.
-
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(required): string
Title:
Name
Maximum Length:160
The name for the expression. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit.
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
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
Nested Schema : incentiveCompensationExpressions-ExpressionDetails-item-post-request
Type:
Show Source
object
-
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.
Nested Schema : incentiveCompensationExpressions-ExpressionUsages-item-post-request
Type:
Show Source
object
-
ExpressionId: integer
(int64)
The unique identifier for the expression associated with a business unit.
-
ExpressionUsageId: integer
(int64)
The unique identifier for the expression usage.
-
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.
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.
Root Schema : incentiveCompensationExpressions-item-response
Type:
Show Source
object
-
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationExpressions-ExpressionDetails-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : incentiveCompensationExpressions-ExpressionUsages-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessUnitPVO
-
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
-
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
- finder:
- CnLookupExpressionTypeVO
-
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
- finder:
- 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. - incentiveCompensationExpressionsUniqID:
- 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. - incentiveCompensationExpressionsUniqID:
Examples
The following example shows how to create an expression by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Name": "Credit Amount Expression", "OrgId" : 204, "Description" : "Expression for a basic credit amount." }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "Description" : "Expression for a basic 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:15:48.805-07:00", "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateLogin" : "575797B8081D23A2E0532DD6F00A5925", "links" : [ { ... } ] }