Get all plan component rate tables
get
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables
Request
Path Parameters
-
ParticipantPlanComponentId(required): integer(int64)
The unique identifier of the plan component associated with the participant compensation plan.
-
participantCompensationPlansUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Participant Compensation Plans resource and used to uniquely identify an instance of Participant Compensation Plans. The client should not generate the hash key value. Instead, the client should query on the Participant Compensation Plans collection resource in order to navigate to a specific instance of Participant Compensation Plans to get the hash key.
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 a participant plan component rate table with the specified primary key.
Finder Variables:- ParticipantPlanComponentRateTableId; integer; The unique identifier of the participant plan component rate table.
- PrimaryKey: Finds a participant plan component rate table 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:- CreatedBy; string; The user who created the participant rate table.
- CreationDate; string; The date and time when the participant rate table is created.
- EndDate; string; The date when the rate table associated with the plan component becomes inactive.
- LastUpdateDate; string; The date and time when the participant rate table is last updated.
- LastUpdatedBy; string; The user who last updated the participant rate table.
- ParticipantPlanComponentId; integer; The unique identifier of the plan component associated with the participant compensation plan.
- ParticipantPlanComponentRateTableId; integer; The unique identifier of the rate table associated with the participant plan component.
- PlanComponentId; integer; The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
- RateTableDescription; string; The description of the rate table entered while creating the rate table.
- RateTableId; integer; The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
- RateTableName; string; The name of the rate table.
- StartDate; string; The date when the rate table associated with the plan component becomes active.
-
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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables
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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant rate table. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the participant rate table is created. -
EndDate: string
(date)
Read Only:
true
The date when the rate table associated with the plan component becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the participant rate table is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant rate table. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantPlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component associated with the participant compensation plan. -
ParticipantPlanComponentRateTableId: integer
(int64)
Read Only:
true
The unique identifier of the rate table associated with the participant plan component. -
ParticipantRateTableRates: array
Rate Table Rates
Title:
Rate Table Rates
The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
RateTableDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the rate table entered while creating the rate table. -
RateTableId: integer
(int64)
The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
-
RateTableName: string
Title:
Name
Read Only:true
Maximum Length:80
The name of the rate table. -
StartDate: string
(date)
Read Only:
true
The date when the rate table associated with the plan component becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rate Table Rates
Type:
array
Title:
Rate Table Rates
The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant 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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant rate table. -
CreationDate: string
(date-time)
Read Only:
true
The date when the participant rate table was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the participant rate table was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant rate table. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantPlanComponentRateTableId: integer
(int64)
Read Only:
true
The unique identifier of the participant rate table. -
ParticipantRateTableRateId: integer
(int64)
The unique identifier of the rate associated with the participant rate table.
-
Rate: number
Title:
Rate
The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value. -
RateDimension10Id: integer
The unique identifier of the tenth dimension associated with the rate. Used only when the rate table has ten dimensions.
-
RateDimension10Name: string
Title:
Name
Read Only:true
The name of the tenth dimension. -
RateDimension10TierId: integer
The unique identifier of the tier for the tenth dimension associated with the rate.
-
RateDimension10TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension1Id: integer
The unique identifier of the first dimension associated with the rate.
-
RateDimension1Name: string
Title:
Name
Read Only:true
The name of the first dimension. -
RateDimension1TierId: integer
The unique identifier of the tier for the first dimension associated with the rate.
-
RateDimension1TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension2Id: integer
The unique identifier of the second dimension associated with the rate. Used only when the rate table has at least two dimensions.
-
RateDimension2Name: string
Title:
Name
Read Only:true
The name of the second dimension. -
RateDimension2TierId: integer
The unique identifier of the tier for the second dimension associated with the rate.
-
RateDimension2TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension3Id: integer
The unique identifier of the third dimension associated with the rate. Used only when the rate table has at least three dimensions.
-
RateDimension3Name: string
Title:
Name
Read Only:true
The name of the third dimension. -
RateDimension3TierId: integer
The unique identifier of the tier for the third dimension associated with the rate.
-
RateDimension3TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension4Id: integer
The unique identifier of the fourth dimension associated with the rate. Used only when the rate table has at least four dimensions.
-
RateDimension4Name: string
Title:
Name
Read Only:true
The name of the fourth dimension. -
RateDimension4TierId: integer
The unique identifier of the tier for the fourth dimension associated with the rate.
-
RateDimension4TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension5Id: integer
The unique identifier of the fifth dimension associated with the rate. Used only when the rate table has at least five dimensions.
-
RateDimension5Name: string
Title:
Name
Read Only:true
The name of the fifth dimension. -
RateDimension5TierId: integer
The unique identifier of the tier for the fifth dimension associated with the rate.
-
RateDimension5TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension6Id: integer
The unique identifier of the sixth dimension associated with the rate. Used only when the rate table has at least six dimensions.
-
RateDimension6Name: string
Title:
Name
Read Only:true
The name of the sixth dimension. -
RateDimension6TierId: integer
The unique identifier of the tier for the sixth dimension associated with the rate.
-
RateDimension6TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension7Id: integer
The unique identifier of the seventh dimension associated with the rate. Used only when the rate table has at least seven dimensions.
-
RateDimension7Name: string
Title:
Name
Read Only:true
The name of the seventh dimension. -
RateDimension7TierId: integer
The unique identifier of the tier for the seventh dimension associated with the rate.
-
RateDimension7TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension8Id: integer
The unique identifier of the eighth dimension associated with the rate. Used only when the rate table has at least eight dimensions.
-
RateDimension8Name: string
Title:
Name
Read Only:true
The name of the eighth dimension. -
RateDimension8TierId: integer
The unique identifier of the tier for the eighth dimension associated with the rate.
-
RateDimension8TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension9Id: integer
The unique identifier of the ninth dimension associated with the rate. Used only when the rate table has at least nine dimensions.
-
RateDimension9Name: string
Title:
Name
Read Only:true
The name of the ninth dimension. -
RateDimension9TierId: integer
The unique identifier of the tier for the ninth dimension associated with the rate.
-
RateDimension9TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateTableId: integer
(int64)
Read Only:
true
The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
RateTableRateId: integer
(int64)
Read Only:
true
The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source