Get a grade rate
get
/hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}
Request
Path Parameters
-
gradeRatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Grade Rates resource and used to uniquely identify an instance of Grade Rates. The client should not generate the hash key value. Instead, the client should query on the Grade Rates collection resource in order to navigate to a specific instance of Grade 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:
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 : gradeRates-item-response
Type:
Show Source
object
-
ActionReasonCode: string
Maximum Length:
255
Code for the action reason of the grade rate. -
ActiveStatus: string
Maximum Length:
30
Active status of the grade rate. -
AnnualizationFactor: number
Annualization factor used to convert the grade rate values to an annual amount.
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
Code of the currency associated with the grade rate. -
EffectiveEndDate: string
(date)
Effective end date of the grade rate.
-
EffectiveStartDate: string
(date)
Effective start date of the grade rate.
-
GradeRateName: string
Title:
Name
Maximum Length:240
Name of the grade rate. -
LegislativeDataGroupId: integer
(int64)
Surrogate identifier of 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 hourly or monthly. Values come from the CMP_SALARY_BASIS lookup. -
RateId: integer
(int64)
Surrogate identifier of the grade rate.
-
RateType: string
Maximum Length:
30
Type of rate such as salary or bonus. Values come from the GRADE_PAY_RATE_TYPE lookup. -
rateValues: array
Grade Rates Rate Values
Title:
Grade Rates Rate Values
The rateValues resource is a child of the gradeRates resource. It provides information about the grades included in a grade rate, such as the minimum, maximum, midpoint, and value amounts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Grade Rates Rate Values
Type:
array
Title:
Grade Rates Rate Values
The rateValues resource is a child of the gradeRates resource. It provides information about the grades included in a grade rate, such as the minimum, maximum, midpoint, and value amounts.
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 : gradeRates-rateValues-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the grade rate values record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the grade rate values record. -
GradeId: integer
Read Only:
true
Surrogate identifier of the grade defined in the grade rate values record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
The maximum rate value for the grade defined in the grade rate values record.
-
MidValueAmount: number
The midpoint rate value for the grade defined in the grade rate values record.
-
MinimumAmount: number
The minimum rate value for the grade defined in the grade rate values record.
-
RateValueId: integer
(int64)
Surrogate identifier of the grade rate value record.
-
ValueAmount: number
The rate value for the grade defined in the grade rate values record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- rateValues
-
Parameters:
- gradeRatesUniqID:
$request.path.gradeRatesUniqID
The rateValues resource is a child of the gradeRates resource. It provides information about the grades included in a grade rate, such as the minimum, maximum, midpoint, and value amounts. - gradeRatesUniqID:
Examples
The following example shows how to retrieve a grade rate 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/gradeRates/00020000000EACED00057708000110F07BE1B1540000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001604805600078"
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": 300100033294676, "EffectiveStartDate": "1951-01-01", "EffectiveEndDate": "4712-12-31", "LegislativeDataGroupId": 300100003140607, "RateType": "SALARY", "GradeRateName": "UK IC 4 Rate", "CurrencyCode": "GBP", "RateFrequency": "ANNUAL", "AnnualizationFactor": 1, "ActiveStatus": "A", "ActionReasonCode": null, "links": [ { ...} }