1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Participant Simulations

Get all calculation estimations

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimations

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 simulation based on a primary key.
      Finder Variables
      • SimulationId; integer; Unique identifier for a 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:
    • AsynchronousRequestId; integer; Indicates the request ID of the job used to execute the calculation simulation asynchronously.
    • CalculationCurrencyCode; string; The participant's calculation currency code.
    • CreatedBy; string; Who column: indicates the user who created the row.
    • CreationDate; string; Who column: indicates the date and time of the creation of the row.
    • CurrentEarningsSumCalculation; number; Current earnings in calculation currency
    • CurrentEarningsSumHome; number; The sum of the earnings in home currency already earned by a participant before the calculation simulation.
    • EndPayPeriodId; integer; The highest pay period ID for the earnings in this calculation simulation.
    • ErrorCode; string; When the calculation simulation ends in error status, this value indicates the error type.
    • GainSumCalculation; number; Earnings gain in calculation currency
    • GainSumHome; number; The sum of the gain in home currency calculated during the calculation simulation.
    • HomeCurrencyCode; string; The participant's home currency code.
    • LastUpdateDate; string; Who column: indicates the date and time of the last update of the row.
    • LastUpdateLogin; string; Who column: indicates the session login associated to the user who last updated the row.
    • LastUpdatedBy; string; Who column: indicates the user who last updated the row.
    • OrgId; integer; The unique identifier of the business unit.
    • ProcessAuditId; integer; Foreign key to relate the processing logs stored in cn_process_audits_all table.
    • ProcessingDate; string; The date when this calculation simulation was processed.
    • ProcessingStatus; string; The status of the calculation simulation, used to know if the simulation is ready to be processed, is being processed, has completed, or has ended in error.
    • SimulationId; integer; Unique identifier for a calculation simulation.
    • SimulationType; string; Defines the type of processing that needs to be used in this simulation.
    • StartPayPeriodId; integer; The lowest pay period ID for the earnings in this calculation simulation.
  • 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 : incentiveCompensationEstimations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationEstimations-item-response
Type: object
Show Source
Nested Schema : Participant Simulation Transactions
Type: array
Title: Participant Simulation Transactions
The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.
Show Source
Nested Schema : incentiveCompensationEstimations-Transactions-item-response
Type: object
Show Source
Nested Schema : Participant Simulation Credits
Type: array
Title: Participant Simulation Credits
The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.
Show Source
Nested Schema : SimulationTransactionDFF
Type: array
Show Source
Nested Schema : incentiveCompensationEstimations-Transactions-Credits-item-response
Type: object
Show Source
Nested Schema : incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-response
Type: object
Show Source
Back to Top