Update a rate table rate
patch
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}
Request
Path Parameters
-
ParticipantPlanComponentId(required): integer(int64)
The unique identifier of the plan component associated with the participant compensation plan.
-
ParticipantPlanComponentRateTableId(required): integer(int64)
The unique identifier of the rate table associated with the participant plan component.
-
ParticipantRateTableRateId(required): integer(int64)
The unique identifier of the rate associated with the participant rate table.
-
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
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 : 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
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
- RateDimensionLookupVO1
-
The list of values containing the unique identifiers of rate dimensions in sequence 1 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension1Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO10
-
The list of values containing the unique identifiers of rate dimensions in sequence 10 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension10Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO2
-
The list of values containing the unique identifiers of rate dimensions in sequence 2 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension2Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO3
-
The list of values containing the unique identifiers of rate dimensions in sequence 3 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension3Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO4
-
The list of values containing the unique identifiers of rate dimensions in sequence 4 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension4Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO5
-
The list of values containing the unique identifiers of rate dimensions in sequence 5 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension5Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO6
-
The list of values containing the unique identifiers of rate dimensions in sequence 6 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension6Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO7
-
The list of values containing the unique identifiers of rate dimensions in sequence 7 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension7Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO8
-
The list of values containing the unique identifiers of rate dimensions in sequence 8 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension8Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionLookupVO9
-
The list of values containing the unique identifiers of rate dimensions in sequence 9 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension9Id; Target Attribute: RateDimensionId
- Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence
- RateDimensionTierLookupVO1
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 1 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension1TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO10
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 10 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension10TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO2
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 2 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension2TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO3
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 3 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension3TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO4
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 4 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension4TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO5
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 5 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension5TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO6
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 6 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension6TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO7
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 7 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension7TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO8
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 8 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension8TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue
- RateDimensionTierLookupVO9
-
The list of values containing the unique identifiers of rate dimensions tiers in sequence 9 of the rate table.
The following properties are defined on the LOV link relation:- Source Attribute: RateDimension9TierId; Target Attribute: RateDimensionTierId
- Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue