Get a step rate
get
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}
Request
Path Parameters
-
gradeLaddersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Grade Ladders resource and used to uniquely identify an instance of Grade Ladders. The client should not generate the hash key value. Instead, the client should query on the Grade Ladders collection resource in order to navigate to a specific instance of Grade Ladders to get the hash key.
-
stepRatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Step Rates resource and used to uniquely identify an instance of Step Rates. The client should not generate the hash key value. Instead, the client should query on the Step Rates collection resource in order to navigate to a specific instance of Step Rates 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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(required):
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(required):
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 : gradeLadders-stepRates-item-response
Type:
Show Source
object
-
ActiveStatus: string
Maximum Length:
30
Status of the step rate such as active or inactive. Valid values are defined in the list ValidateStatus. -
AnnualizationFactor: number
Default value based on the selected frequency. For example, 1 for Annual, 12 for monthly, 2080 for hourly, or a manually provided value in the UI.
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code for the rate values defined for the rate. Valid values are defined in the list ListOfCurrencies. -
EffectiveEndDate: string
(date)
Date at the end of the date range within which the step rate is effective.
-
EffectiveStartDate: string
(date)
Date at the beginning of the date range within which the step rate is effective.
-
LegislationCode: string
Maximum Length:
30
Legislation code derived from the legislative data group. -
LegislativeDataGroupId: integer
(int64)
Unique identifier for the legislative data group.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RateFrequency: string
Maximum Length:
30
Frequency of the rate such as Annual, Monthly, or Hourly payroll period. Valid values are defined in the list ValidateRateFrequency. -
RateId: integer
(int64)
Unique identifier for the step rate.
-
RateName: string
Title:
Name
Maximum Length:240
Name of the step rate. -
RateType: string
Maximum Length:
30
Type of step rate such as Salary, Bonus, or Overtime. Valid values are defined in the list ListOfRateType. -
stepRateValues: array
Step Rate Values
Title:
Step Rate Values
The stepRateValues resource is a child of the stepRates resource. It includes monetary values defined for the grade steps and the given step rate, as of the specified date.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Step Rate Values
Type:
array
Title:
Step Rate Values
The stepRateValues resource is a child of the stepRates resource. It includes monetary values defined for the grade steps and the given step rate, as of the specified date.
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 : gradeLadders-stepRates-stepRateValues-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the step rate value is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the step rate value is effective. -
GradeStepId: integer
Unique identifier for the grade step.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RateValueId: integer
(int64)
Unique identifier for the rate value.
-
StepRateValueAmount: number
Value amount of the step rate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- stepRateValues
-
Parameters:
- gradeLaddersUniqID:
$request.path.gradeLaddersUniqID
- stepRatesUniqID:
$request.path.stepRatesUniqID
The stepRateValues resource is a child of the stepRates resource. It includes monetary values defined for the grade steps and the given step rate, as of the specified date. - gradeLaddersUniqID:
Examples
The following example shows how to retrieve a step rate associated with a grade ladder by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/gradeLadders/00020000000EACED00057708000110F0808E762A0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001604805600078/child/stepRates/00070000000EACED00057708000110F0808E76390000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708FFFFFF746419F000780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0808E76390000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708FFFFFF746419F000780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD140078000000025553"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RateId": 300100111726137, "EffectiveStartDate": "1951-01-01", "EffectiveEndDate": "4712-12-31", "LegislativeDataGroupId": 300100002693764, "LegislationCode": "GB", "RateName": "UK annual bonus", "RateType": "BONUS", "CurrencyCode": "GBP", "RateFrequency": "ANNUAL", "AnnualizationFactor": 1, "ActiveStatus": "A", "links": [ { ...} }