Get all plan components
get
/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents
Request
Path Parameters
-
CompensationPlanId(required): integer(int64)
The unique identifier of the compensation plan.
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 -
finder: string
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 plan component with the specified primary key.
Finder Variables:- CompensationPlanComponentId; integer; The unique identifier of a plan component.
- PrimaryKey: Finds the plan component with the specified primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CalculateIncentive; string; Indicates whether the nature of plan component earning calculation is per event or per interval. Possible values include BONUS for per interval, and COMMISSION for per event. This cannot be updated once the plan component has been created. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- CalculationPhase; integer; The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2. The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- CalculationSequence; integer; Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1.
- CompensationPlanComponentId; integer; The unique identifier for a plan component associated with a compensation plan.
- CompensationPlanId; integer; The unique identifier for a compensation plan.
- CompensationPlanName; string; The name of the compensation plan.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date and time when the record was created.
- EndDate; string; The date and time when the plan component associated with a compensation plan becomes inactive. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.
- LastUpdateDate; string; The session login associated to the user who last updated the record.
- LastUpdateLogin; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- PlanComponentId; integer; The unique identifier of a plan component.
- PlanComponentName; string; The name of a plan component.
- PlanComponentValidForCalculation; string; Indicates whether the plan component is ready for calculation. Possible values include COMPLETE when the plan component is valid and ready for calculation, and INCOMPLETE when the plan component is not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- StartDate; string; The date and time when the plan component associated with a compensation plan becomes active. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.
- TargetIncentiveAmount; number; The amount for each plan component derived by multiplying the weight with the compensation plan target incentive.
- TargetIncentivePercent; number; The percentage of influence a plan component has on the compensation plan. The default value is 100.
-
totalResults: boolean
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
-
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 : compensationPlans-CompensationPlanComponents
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : compensationPlans-CompensationPlanComponents-item-response
Type:
Show Source
object
-
CalculateIncentive: string
Title:
Calculate Incentive
Read Only:true
Maximum Length:30
Indicates whether the nature of plan component earning calculation is per event or per interval. Possible values include BONUS for per interval, and COMMISSION for per event. This cannot be updated once the plan component has been created. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CalculationPhase: integer
(int32)
Title:
Calculation Phase
Read Only:true
The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2. The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CalculationSequence: integer
(int64)
Title:
Calculation Sequence
Default Value:1
Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1. -
CompensationPlanComponentId: integer
(int64)
The unique identifier for a plan component associated with a compensation plan.
-
CompensationPlanId: integer
(int64)
Title:
Compensation Plan ID
The unique identifier for a compensation plan. -
CompensationPlanName: string
Title:
Compensation Plan Name
Read Only:true
Maximum Length:80
The name of the compensation plan. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date)
Title:
End Date
The date and time when the plan component associated with a compensation plan becomes inactive. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The session login associated to the user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
The unique identifier of a plan component. -
PlanComponentName: string
Title:
Plan Component Name
Read Only:true
Maximum Length:80
The name of a plan component. -
PlanComponentValidForCalculation: string
Title:
Valid for Calculation
Read Only:true
Maximum Length:30
Default Value:INCOMPLETE
Indicates whether the plan component is ready for calculation. Possible values include COMPLETE when the plan component is valid and ready for calculation, and INCOMPLETE when the plan component is not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
The date and time when the plan component associated with a compensation plan becomes active. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null. -
TargetIncentiveAmount: number
Title:
Target Incentive Amount
Read Only:true
Default Value:100
The amount for each plan component derived by multiplying the weight with the compensation plan target incentive. -
TargetIncentivePercent: number
Title:
Target Incentive Percent
Default Value:100
The percentage of influence a plan component has on the compensation plan. The default value is 100.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example shows how to get all plan components by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans/300100090306794/child/compensationPlanComponents
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "PlanComponentId": 300100085059410, "CalculationSequence": 1, "TargetIncentivePercent": 90, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "CalculationPhase": 1, "CalculateIncentive": "BONUS", "PlanComponentValidForCalculation": "COMPLETE", "PlanComponentName": "2016 QA calc scenario 800 PC", "TargetIncentiveAmount": 9000, "CompensationPlanComponentId": 300100090480156, "CompensationPlanId": 300100090306794, "CompensationPlanName": "Silver Inc Plan", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-07T07:52:52-07:00", "LastUpdateDate": "2017-06-07T07:58:01.058-07:00", "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ ... ] }, ...