1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Incentive Compensation Expressions

Get all expressions

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a resource with the specified primary key.
      Finder Variables:
      • ExpressionId; integer; The unique identifier of the business unit.
      • OrgId; integer; The unique identifier of an expression.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • Description; string; The description of the incentive compensation expression.
    • ExpressionId; integer; The unique identifier of the expression.
    • ExpressionType; string; 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.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The session login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Name; string; The name for the expression.
    • OrgId; integer; The unique identifier of the business unit.
    • Status; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : incentiveCompensationExpressions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationExpressions-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Description
    Maximum Length: 1000
    The description of the incentive compensation expression.
  • 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.
  • 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.
  • The unique identifier of the expression.
  • 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.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 160
    The name for the expression.
  • Title: Business Unit
    The unique identifier of the business unit.
  • 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 : incentiveCompensationExpressions-ExpressionDetails-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Display Value
    Read Only: true
    Maximum Length: 160
    The display value of the expression detail record.
  • The unique identifier for the expression detail record.
  • 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.
  • The unique identifier for the expression record.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • The unique identifier for the expression associated with a business unit.
  • Title: Name
    Read Only: true
    Maximum Length: 160
    The name of the expression.
  • The unique identifier for the expression usage.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • 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.
  • 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.
Back to Top

Examples

The following example shows how to get all expressions by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions

Example of Response Body

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

{
  "items" : [ {
    "Description" : null,
    "ExpressionType" : "CALCULATION",
    "OrgId" : 204,
    "ExpressionId" : 300100052331483,
    "Name" : "CN QA group by measure with RTR. ITD output",
    "Status" : "VALID",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "CreationDate" : "2015-03-19T09:27:00.442-07:00",
    "LastUpdateDate" : "2015-03-19T09:28:58.719-07:00",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdateLogin" : "11A5144D82455BB8E0531833F40A4416",
    "links" : [ {
		...
			}
		]
	},
	{
    "Description" : "S100_PC_OUTPUT_EXP_170817010141423",
    "ExpressionType" : "CALCULATION",
    "OrgId" : 204,
    "ExpressionId" : 300100090733798,
    "Name" : "S100_PC_OUTPUT_EXP_170817010141423",
    "Status" : "VALID",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "CreationDate" : "2017-08-17T01:11:01-07:00",
    "LastUpdateDate" : "2017-08-17T01:12:16.450-07:00",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdateLogin" : "56EF70736CD64C5CE0532DD6F00A2F6B",
    "links" : [ {
		...
			}
		]
	},...
Back to Top