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

Gets a collection of rule qualifying criteria details.

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleQualifyingCriteria

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 the full qualifying criteria of a rule based on the primary key.
      Finder Variables
      • RuleAttrValueId; integer; The unique identifier of the rule attribute value.
      • RuleId; integer; The unique identifier of the rule.
    • RuleIdFinder Finds the full qualifying criteria of a rule using the Rule ID.
      Finder Variables
      • b_rule_id; integer; The unique identifier of the rule.
    • RuleNameFinder Finds the full qualifying criteria of a rule using the Rule Name.
      Finder Variables
      • b_rule_name; string; The name of the rule.
    • RuleNumberFinder Finds the full qualifying criteria of a rule using the Rule Number.
      Finder Variables
      • b_rule_number; string; The number of the rule.
  • 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:
    • AttrUsageId; integer; The unique identifier of the rule attribute usage.
    • AttrValueMeaning; string; The meaning of the rule attribute value.
    • AttributeDescription; string; The description of the rule attribute.
    • AttributeId; integer; The identifier of the qualifier attribute.
    • AttributeName; string; The name of the rule attribute.
    • ComparisonOperator; string; The comparison operator used in the rule attribute.
    • ConvertToIdFlag; boolean; The convert to ID flag indicator for the rule attribute.
    • CreatedBy; string; Indicates the user who created the record.
    • CreationDate; string; Indicates the date and time the record was created.
    • DisplayType; string; The display type of the rule attribute.
    • EnabledFlag; boolean; Indicates whether the rule attribute is active.
    • EndDate; string; The end date of the rule.
    • HighValueChar; string; The high value for character type rule attribute value.
    • HighValueNumber; number; The high value for number type rule attribute value.
    • LastUpdateDate; string; Indicates the date and time the record was last updated.
    • LastUpdateLogin; string; Indicates the session login associated to the user who last updated the record.
    • LastUpdatedBy; string; Indicates the user who last updated the record.
    • LevelFromParent; number; Indicates how far the rule is from the parent rule.
    • LevelFromRoot; number; Indicates how far the rule is from the root node of the hierarchy.
    • LookupCode; string; The lookup code of the operator.
    • LookupMeaning; string; The lookup meaning of the operator.
    • LookupType; string; The lookup type of the comparison operator.
    • LowValueChar; string; The low value for character type rule attribute value.
    • LowValueCharCode; string; The low value code for character type rule attribute value.
    • LowValueCharId; integer; The low value identifier for character type rule attribute value.
    • LowValueNumber; number; The low value for number type rule attribute value.
    • NumberOfWinners; integer; The number of winners for the rule hierarchy.
    • OrgId; integer; The unique identifier of the rule's business unit.
    • Rank; integer; The rank of the rule.
    • RuleAttrValueId; integer; The identifier of the rule attribute value.
    • RuleAttributeId; integer; The identifier of the rule attribute.
    • RuleDescription; string; The description of the rule.
    • RuleId; integer; The unique identifier of the rule.
    • RuleName; string; The name of the rule.
    • RuleNumber; string; The number of the rule.
    • StartDate; string; The start date of the rule.
    • UsageId; integer; The usage identifier of the rule attribute.
  • 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 : incentiveCompensationRuleQualifyingCriteria
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationRuleQualifyingCriteria-item-response
Type: object
Show Source
Back to Top