Create a rate table
post
/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables
Request
Path Parameters
-
IncentiveFormulaId(required): integer(int64)
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
-
planComponentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EndDate: string
(date)
Title:
End Date
The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd. -
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component. -
PlanComponentRateTableId: integer
(int64)
The unique identifier of the rate table associated to the plan component.
-
RateTableId: integer
(int64)
Title:
Rate Table ID
The unique identifier of the rate table. -
RateTableName: string
Title:
Rate Table Name
Maximum Length:80
The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels. -
StartDate: string
(date)
Title:
Start Date
The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.
Response
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 : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
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 when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd. -
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanComponentId: integer
Read Only:
true
The unique identifier for the plan component record within a business unit. -
PlanComponentName: string
Title:
Plan Component Name
Read Only:true
The name of a plan component, which defines the earnings of a participant based on their performance. -
PlanComponentRateTableId: integer
(int64)
The unique identifier of the rate table associated to the plan component.
-
RateTableDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the rate table. -
RateTableId: integer
(int64)
Title:
Rate Table ID
The unique identifier of the rate table. -
RateTableName: string
Title:
Rate Table Name
Maximum Length:80
The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels. -
StartDate: string
(date)
Title:
Start Date
The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.
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.
Links
- RateTableVO
-
The rate table resource is used to create, update or delete a rate table. It can also be used to display all details of rate tables. The plan component rate table determines the compensation rate for the earnings calculations. The performance measure scorecard is used to establish attainment rates or fixed amounts for different performance levels.