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

Get all compensation estimation insights

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights

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

    • OptyFinder Finds the collection with the opportunity finder.
      Finder Variables
      • OptyId; integer; The source object identifier. For opportunity estimates, this will be the opportunity identifier.
      • OptyNumber; string; The source object number. For opportunity estimates, this will be the opportunity number.
    • PrimaryKey Finds the collection with the specified primary key.
      Finder Variables
      • 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:
    • AsynchronousRequestId; integer; The unique identifier of the job used to execute the calculation simulation asynchronously.
    • CalculationCurrencyCode; string; The calculation currency code.
    • CreatedBy; string; The user who created the calculation simulation.
    • CreationDate; string; The date and time when the calculation simulation was created.
    • CurrentEarningsSumCalculation; number; The sum of the earnings in calculation currency already earned by a participant before the calculation simulation.
    • CurrentEarningsSumFunctional; number; The sum of the earnings in functional currency already earned by a participant before the calculation simulation.
    • 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 identifier for the earnings in this calculation simulation.
    • ErrorCode; string; When the calculation simulation ends in error or warning status, this value indicates the error type.
    • GainSumCalculation; number; The sum of the gain in calculation currency calculated during the calculation simulation.
    • GainSumFunctional; number; The sum of the gain in functional currency calculated during the calculation simulation.
    • GainSumHome; number; The sum of the gain in home currency calculated during the calculation simulation.
    • HomeCurrencyCode; string; Participant's home currency code.
    • LastUpdateDate; string; The date and time when the calculation simulation was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the calculation simulation.
    • LastUpdatedBy; string; The user who last updated the calculation simulation.
    • OrgId; integer; The unique identifier of the business unit associated with the simulation.
    • ParticipantId; integer; The unique identifier of the participant for which the simulation was created.
    • ParticipantName; string; The name of the participant for which the simulation was created.
    • PartyNumber; string; The party number of the participant for which the simulation was created.
    • ProcessAuditId; integer; The unique identifier of the process audit used to find the process audit logs.
    • ProcessingDate; string; The date when the simulation was processed.
    • ProcessingStatus; string; The status of the simulation process.
    • SimulationId; integer; The unique identifier of the calculation simulation.
    • SimulationName; string; An optional user-friendly name to identify the calculation simulation.
    • SourceObjectId; integer; The system identifier of the object for which the simulation was created.
    • SourceObjectNumber; string; The user provided identifier of the object for which the simulation was created. For opportunity based simulations, this will be the opportunity number.
    • SourceObjectType; string; The type of object for which the simulation was created.
    • StartPayPeriodId; integer; The lowest pay period identifier for the earnings in this calculation simulation.
    • UpdateQueued; string; Indicates there is a new simulation with the same name in queue to be processed.
  • 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 : incentiveCompensationEstimationInsights
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationEstimationInsights-item-response
Type: object
Show Source
Nested Schema : Estimation Summary by Plan Components
Type: array
Title: Estimation Summary by Plan Components
The summary by plan components resource is used to view simulation results by plan component.
Show Source
Nested Schema : incentiveCompensationEstimationInsights-SummaryByPlanComponent-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all calculation simulations by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

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

{
    "items": [
        {
            "SimulationId": 10034,
            "SimulationName": "300100052468154_300100562426638",
            "SourceObjectType": "opportunities",
            "SourceObjectId": 300100562426638,
            "SourceObjectNumber": "CDRM_128503",
            "ParticipantId": 19001,
            "ParticipantName": "Stephanie Rodriquez",
            "PartyNumber": "CDRM_91767",
            "OrgId": 204,
            "ProcessingDate": "2022-12-07T00:59:37+00:00",
            "ProcessingStatus": "ORA_CN_ERROR",
            "ErrorCode": "ORA_CN_CLASSIFICATION",
            "CurrentEarningsSumCalculation": null,
            "CurrentEarningsSumFunctional": null,
            "CurrentEarningsSumHome": null,
            "GainSumCalculation": null,
            "GainSumFunctional": null,
            "GainSumHome": null,
            "CalculationCurrencyCode": null,
            "HomeCurrencyCode": null,
            "StartPayPeriodId": null,
            "EndPayPeriodId": null,
            "ProcessAuditId": null,
            "AsynchronousRequestId": 113248,
            "CreationDate": "2022-12-07T00:59:20+00:00",
            "CreatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateDate": "2022-12-07T00:59:20+00:00",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateLogin": "EF32F6361D0B9F77E0536902F40A94FC",
            "UpdateQueued": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034/child/SummaryByPlanComponent",
                    "name": "SummaryByPlanComponent",
                    "kind": "collection"
                }
            ]
        },
        {
            "SimulationId": 10041,
            "SimulationName": "300100052468154_300100562444658",
            "SourceObjectType": "opportunities",
            "SourceObjectId": 300100562444658,
            "SourceObjectNumber": "CDRM_128508",
            "ParticipantId": 19001,
            "ParticipantName": "Stephanie Rodriquez",
            "PartyNumber": "CDRM_91767",
            "OrgId": 204,
            "ProcessingDate": "2022-12-07T00:59:36+00:00",
            "ProcessingStatus": "ORA_CN_ERROR",
            "ErrorCode": "ORA_CN_CLASSIFICATION",
            "CurrentEarningsSumCalculation": null,
            "CurrentEarningsSumFunctional": null,
            "CurrentEarningsSumHome": null,
            "GainSumCalculation": null,
            "GainSumFunctional": null,
            "GainSumHome": null,
            "CalculationCurrencyCode": null,
            "HomeCurrencyCode": null,
            "StartPayPeriodId": null,
            "EndPayPeriodId": null,
            "ProcessAuditId": null,
            "AsynchronousRequestId": 113249,
            "CreationDate": "2022-12-07T00:59:20+00:00",
            "CreatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateDate": "2022-12-07T00:59:20+00:00",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateLogin": "EF32F6361D0B9F77E0536902F40A94FC",
            "UpdateQueued": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041/child/SummaryByPlanComponent",
                    "name": "SummaryByPlanComponent",
                    "kind": "collection"
                }
            ]
        }
    ],
..
}
Back to Top