Update a rate table rate
patch
/fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates/{RateTableRateId}
Request
Path Parameters
-
RateTableId(required): integer(int64)
The unique identifier for the rate table.
-
RateTableRateId(required): integer(int64)
The unique identifier of the rate table value.
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
-
OrgId: integer
(int64)
The unique identifier of the business unit. You can update this value from a list of acceptable values in the Manage Business Units task in Setup and Maintenance work area.
-
Rate: number
Title:
Rate
The output value of the rate table, which can be used to calculate the earning rate or the attainment rate. This value could be 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. -
RateTableId: integer
(int64)
The unique identifier of the rate table.
-
RateTableNumberDim: integer
Title:
Number of Dimensions
The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.
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 : rateTables-RateTableRates-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
The unique identifier of the business unit. You can update this value from a list of acceptable values in the Manage Business Units task in Setup and Maintenance work area.
-
Rate: number
Title:
Rate
The output value of the rate table, which can be used to calculate the earning rate or the attainment rate. This value could be 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: string
The unique identifier of the tenth rate dimension record associated with the rate value. This value will only be filled if the rate table has 10 rate dimensions.
-
RateDimension10TierId: string
The unique identifier of the tenth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 10 rate dimensions.
-
RateDimension1Id: string
The unique identifier of the first rate dimension record associated with the rate value.
-
RateDimension1TierId: string
The unique identifier of the first rate dimension tier associated with the rate value.
-
RateDimension2Id: string
The unique identifier of the second rate dimension record associated with the rate value. This value will only be filled if the rate table has 2 or more rate dimensions.
-
RateDimension2TierId: string
The unique identifier of the second rate dimension tier associated with the rate value. This value will only be filled if this rate table has 2 or more rate dimensions.
-
RateDimension3Id: string
The unique identifier of the third rate dimension record associated with the rate value. This value will only be filled if the rate table has 3 or more rate dimensions.
-
RateDimension3TierId: string
The unique identifier of the third rate dimension tier associated with the rate value. This value will only be filled if this rate table has 3 or more rate dimensions.
-
RateDimension4Id: string
The unique identifier of the fourth rate dimension record associated with the rate value. This value will only be filled if the rate table has 4 or more rate dimensions.
-
RateDimension4TierId: string
The unique identifier of the fourth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 4 or more rate dimensions.
-
RateDimension5Id: string
The unique identifier of the fifth rate dimension record associated with the rate value. This value will only be filled if the rate table has 5 or more rate dimensions.
-
RateDimension5TierId: string
The unique identifier of the fifth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 5 or more rate dimensions.
-
RateDimension6Id: string
The unique identifier of the sixth rate dimension record associated with the rate value. This value will only be filled if the rate table has 6 or more rate dimensions.
-
RateDimension6TierId: string
The unique identifier of the sixth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 6 or more rate dimensions.
-
RateDimension7Id: string
The unique identifier of the seventh rate dimension record associated with the rate value. This value will only be filled if the rate table has 7 or more rate dimensions.
-
RateDimension7TierId: string
The unique identifier of the seventh rate dimension tier associated with the rate value. This value will only be filled if this rate table has 7 or more rate dimensions.
-
RateDimension8Id: string
The unique identifier of the eighth rate dimension record associated with the rate value. This value will only be filled if the rate table has 8 or more rate dimensions.
-
RateDimension8TierId: string
The unique identifier of the eighth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 8 or more rate dimensions.
-
RateDimension9Id: string
The unique identifier of the ninth rate dimension record associated with the rate value. This value will only be filled if the rate table has 9 or more rate dimensions.
-
RateDimension9TierId: string
The unique identifier of the ninth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 9 or more rate dimensions.
-
RateTableId: integer
(int64)
The unique identifier of the rate table.
-
RateTableNumberDim: integer
Title:
Number of Dimensions
The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions. -
RateTableRateId: integer
(int64)
Read Only:
true
The unique identifier of the rate table value. -
RateTableRatesDeleteFlag: boolean
Read Only:
true
Maximum Length:255
Indicates that the rate table rates record cannot be deleted using this service.
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 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.
- RateDimensionLookupVO10
-
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.
- RateDimensionLookupVO2
-
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.
- RateDimensionLookupVO3
-
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.
- RateDimensionLookupVO4
-
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.
- RateDimensionLookupVO5
-
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.
- RateDimensionLookupVO6
-
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.
- RateDimensionLookupVO7
-
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.
- RateDimensionLookupVO8
-
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.
- RateDimensionLookupVO9
-
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.
- RateDimensionTierLookupVO1
-
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.
- RateDimensionTierLookupVO10
-
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.
- RateDimensionTierLookupVO2
-
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.
- RateDimensionTierLookupVO3
-
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.
- RateDimensionTierLookupVO4
-
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.
- RateDimensionTierLookupVO5
-
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.
- RateDimensionTierLookupVO6
-
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.
- RateDimensionTierLookupVO7
-
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.
- RateDimensionTierLookupVO8
-
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.
- RateDimensionTierLookupVO9
-
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.