1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Calculation Simulations
  4. Simulation Meause Results

Get all simulation measure results

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/MeasureResults

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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:

    • MeasureResultIdFinder: Finds a simulation earning with the specified simulation measure result identifier.
      Finder Variables:
      • MeasureResultId; integer; The unique identifier of the simulation measure result.
    • PrimaryKey: Finds a simulation measure result with the specified primary key.
      Finder Variables:
      • MeasureResultId; integer; The unique identifier of the simulation measure result.
      • SimulationId; integer; The unique identifier of the calculation simulation.
  • 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:
    • CalculationCurrency; string; The calculation currency code.
    • CommissionValue; number; The rate of the rate table.
    • CompensationPlanId; integer; The unique identifier of the compensation plan for which the measure results are calculated.
    • CompensationPlanName; string; The name of the compensation plan for which the measure results are calculated.
    • CreatedBy; string; The user who created the measure result record.
    • CreatedDuring; string; The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.
    • CreationDate; string; The date when the measure result record was created.
    • CreditAmount; number; The credit amount in calculation currency.
    • CreditFactor; number; The credit factor applied to a credit category associated with the performance measure.
    • CreditId; integer; The unique identifier of the credited transaction.
    • CreditedParticipantId; integer; The unique identifier of the participant who receives credit for the transaction.
    • CreditedParticipantName; string; The name of the participant who receives credit for the transaction.
    • EarningFactor; number; The earning factor associated with the performance measure.
    • EarningTypeId; integer; The identifier of the earning type.
    • EligibleCatId; integer; The transaction credit category populated during classification.
    • ErrorReason; string; The reason for error during calculation.
    • EventFactorValue; number; The event factor for a transaction type applied to a credit category associated with the performance measure.
    • FormulaId; integer; The unique identifier of the performance measure for which the measure results are calculated.
    • FormulaWeight; number; The weight of the performance measure within the plan component.
    • InputAchieved; number; The amount passed to the rate table based on the input expression defined in the performance measure.
    • LastUpdateDate; string; The date the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • MeasureResultId; integer; The identifier of the simulation measure result.
    • ObjectStatus; string; The current status of the measure results record, such as calculated, calculation error, eligible, or reversed.
    • ObjectStatusMeaning; string; The display label for the process status lookup code.
    • OrgId; integer; The unique identifier of the business unit associated with the measure result record.
    • OutputAchieved; number; The amount calculated by the output expression of the performance measure.
    • PerformanceMeasureName; string; The name of the performance measure for which the measure results are calculated.
    • PlanComponentId; integer; The unique identifier of the plan component for which the measure results are calculated.
    • PlanComponentName; string; The name of the plan component for which the measure results are calculated.
    • SimulationDeleteFlag; boolean; Indicates whether the measure result was deleted during calculation simulation processing.
    • SimulationId; integer; The identifier of the simulation to which this simulation measure result belongs.
    • SimulationResultType; string; Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.
    • SourceEventDate; string; The date of the simulation transaction.
    • SourceEventPeriodId; integer; The period identifier for the source event date.
    • SourceTrxNumber; string; The transaction number which identifies the transaction.
    • SrpCompensationPlanId; integer; The unique identifier of the participant compensation plan assignment record.
    • TierSplits; integer; The tier of the rate table.
    • TransactionAmount; number; The transaction amount in calculation currency.
    • TransactionId; integer; The unique identifier for the transaction.
    • TransactionType; string; The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • TransactionTypeMeaning; string; The display label for the Transaction Type lookup code.
  • 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 : incentiveCompensationCalculationSimulations-MeasureResults
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationCalculationSimulations-MeasureResults-item-response
Type: object
Show Source
Back to Top