Get a compensation estimation insight
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}
Request
Path Parameters
-
SimulationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : incentiveCompensationEstimationInsights-item-response
Type:
Show Source
object
-
AsynchronousRequestId: integer
(int64)
Read Only:
true
The unique identifier of the job used to execute the calculation simulation asynchronously. -
CalculationCurrencyCode: string
Read Only:
true
Maximum Length:15
The calculation currency code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the calculation simulation. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the calculation simulation was created. -
CurrentEarningsSumCalculation: number
Read Only:
true
The sum of the earnings in calculation currency already earned by a participant before the calculation simulation. -
CurrentEarningsSumFunctional: number
Read Only:
true
The sum of the earnings in functional currency already earned by a participant before the calculation simulation. -
CurrentEarningsSumHome: number
Read Only:
true
The sum of the earnings in home currency already earned by a participant before the calculation simulation. -
EndPayPeriodId: integer
(int64)
Read Only:
true
The highest pay period identifier for the earnings in this calculation simulation. -
ErrorCode: string
Read Only:
true
Maximum Length:30
When the calculation simulation ends in error or warning status, this value indicates the error type. -
GainSumCalculation: number
Read Only:
true
The sum of the gain in calculation currency calculated during the calculation simulation. -
GainSumFunctional: number
Read Only:
true
The sum of the gain in functional currency calculated during the calculation simulation. -
GainSumHome: number
Read Only:
true
The sum of the gain in home currency calculated during the calculation simulation. -
HomeCurrencyCode: string
Read Only:
true
Maximum Length:15
Participant's home currency code. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the calculation simulation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the calculation simulation. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the calculation simulation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit associated with the simulation. -
ParticipantId: integer
(int64)
Read Only:
true
The unique identifier of the participant for which the simulation was created. -
ParticipantName: string
Read Only:
true
Maximum Length:360
The name of the participant for which the simulation was created. -
PartyNumber: string
Read Only:
true
Maximum Length:30
The party number of the participant for which the simulation was created. -
ProcessAuditId: integer
(int64)
Read Only:
true
The unique identifier of the process audit used to find the process audit logs. -
ProcessingDate: string
(date-time)
Read Only:
true
The date when the simulation was processed. -
ProcessingStatus: string
Read Only:
true
Maximum Length:20
Default Value:ORA_CN_NOT_READY
The status of the simulation process. -
SimulationId: integer
(int64)
Read Only:
true
The unique identifier of the calculation simulation. -
SimulationName: string
Read Only:
true
Maximum Length:160
An optional user-friendly name to identify the calculation simulation. -
SourceObjectId: integer
(int64)
Read Only:
true
The system identifier of the object for which the simulation was created. -
SourceObjectNumber: string
Read Only:
true
Maximum Length:30
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
Read Only:
true
Maximum Length:30
The type of object for which the simulation was created. -
StartPayPeriodId: integer
(int64)
Read Only:
true
The lowest pay period identifier for the earnings in this calculation simulation. -
SummaryByPlanComponent: array
Estimation Summary by Plan Components
Title:
Estimation Summary by Plan Components
The summary by plan components resource is used to view simulation results by plan component. -
UpdateQueued: string
Read Only:
true
Maximum Length:1
Indicates there is a new simulation with the same name in queue to be processed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : incentiveCompensationEstimationInsights-SummaryByPlanComponent-item-response
Type:
Show Source
object
-
CalculationCurrencyCode: string
Read Only:
true
Maximum Length:15
The calculation currency code. -
CompensationPlanDisplayName: string
Read Only:
true
Maximum Length:80
The user specified display name of the compensation plan for which the estimation results are being generated. -
CompensationPlanId: integer
(int64)
Read Only:
true
The unique identifier of the compensation plan for which the estimation results are being generated. -
CompensationPlanName: string
Read Only:
true
Maximum Length:80
The unique name that identifies the compensation plan for which the estimation results are being generated. -
CurrentEarningsSumCalculation: number
Read Only:
true
The sum of the earnings in calculation currency already earned by a participant before the calculation simulation. -
CurrentEarningsSumFunctional: number
Read Only:
true
The sum of the earnings in functional currency already earned by a participant before the calculation simulation. -
CurrentEarningsSumHome: number
Read Only:
true
The sum of the earnings in home currency already earned by a participant before the calculation simulation. -
FormulaId: integer
(int64)
Read Only:
true
The unique identifier of the expression used on the plan component to derive estimation results. -
GainSumCalculation: number
Read Only:
true
The sum of the gain in calculation currency calculated during the calculation simulation. -
GainSumFunctional: number
Read Only:
true
The sum of the gain in functional currency calculated during the calculation simulation. -
GainSumHome: number
Title:
Estimated Earnings
Read Only:true
The sum of the gain in home currency calculated during the calculation simulation. -
HomeCurrencyCode: string
Read Only:
true
Maximum Length:15
Participant's home currency code. -
IntervalEndDate: string
(date)
Read Only:
true
The calendar end date of the interval for the plan component's earnings in this calculation simulation. -
IntervalNumber: string
Read Only:
true
Maximum Length:50
The interval number for the plan component's earnings in this calculation simulation. -
IntervalStartDate: string
(date)
Read Only:
true
The calendar start date of the interval for the plan component's earnings in this calculation simulation. -
IntervalTypeName: string
Read Only:
true
Maximum Length:80
The name of the interval type used in the plan component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit associated with the simulation. -
PayPeriodEndDate: string
(date)
Read Only:
true
The calendar end date of the pay period for the plan component's earnings in this calculation simulation. -
PayPeriodId: integer
(int64)
Read Only:
true
The pay period identifier for the plan component's earnings in this calculation simulation. -
PayPeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
The name of the pay period for the plan component's earnings in this calculation simulation. -
PayPeriodStartDate: string
(date)
Read Only:
true
The calendar start date of the pay period for the plan component's earnings in this calculation simulation. -
PlanComponentDisplayName: string
Title:
Plan Component
Read Only:true
Maximum Length:80
The user specified display name of the plan component for which the estimation results are being generated. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component for which the estimation results are being generated. -
PlanComponentName: string
Read Only:
true
Maximum Length:80
The unique name that identifies the compensation plan for which the estimation results are being generated. -
SimulationId: integer
(int64)
Read Only:
true
The unique identifier of the parent calculation simulation. -
SrpCompensationPlanId: integer
(int64)
Read Only:
true
The unique identifier of the participant plan. -
SummaryByPlanComponentId: integer
Read Only:
true
The unique identifier of the participant compensation plan for which the estimation results are being generated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SummaryByPlanComponent
-
Parameters:
- SimulationId:
$request.path.SimulationId
The summary by plan components resource is used to view simulation results by plan component. - SimulationId:
Examples
The following example shows how to get a calculation simulation 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/10034 \ -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.
{ "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" } ] }