Get all grade ladders
get
/hcmRestApi/resources/11.13.18.05/gradeLadders
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all the grade ladders that match the primary key criteria specified.
Finder Variables- EffectiveEndDate; string; Date at the end of the period within which the grade ladder is effective.
- EffectiveStartDate; string; Date at the beginning of the period within which the grade ladder is effective.
- GradeLadderId; integer; Surrogate identifier for the grade ladder.
- findByGradeLadderId Finds all the grade ladders that match the specified grade ladder identifier.
Finder Variables- GradeLadderId; integer; Surrogate identifier for the grade ladder.
- SysEffectiveDate; string;
- PrimaryKey Finds all the grade ladders that match the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActionReasonCode; string; Action reason of the grade ladder.
- ActiveStatus; string; Active status of the grade ladder.
- EffectiveEndDate; string; Date at the end of the period within which the grade ladder is effective.
- EffectiveStartDate; string; Date at the beginning of the period within which the grade ladder is effective.
- GradeLadderId; integer; Surrogate identifier for the grade ladder.
- GradeLadderName; string; Name of the grade ladder.
- GradeSetId; integer; Surrogate identifier for the set to which the grades in the grade ladder belong.
- GradeType; string; Indicates whether the grades in the grade ladder have steps. A value of GRADE means that the grades don't have steps. A value of STEP means that the grades have steps.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : gradeLadders
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : gradeLadders-item-response
Type:
Show Source
object
-
ActionReasonCode: string
Maximum Length:
255
Action reason of the grade ladder. -
ActiveStatus: string
Title:
Status
Maximum Length:30
Active status of the grade ladder. -
EffectiveEndDate: string
(date)
Date at the end of the period within which the grade ladder is effective.
-
EffectiveStartDate: string
(date)
Date at the beginning of the period within which the grade ladder is effective.
-
gradeLadderDFF: array
gradeLadderDFF
-
GradeLadderId: integer
(int64)
Surrogate identifier for the grade ladder.
-
GradeLadderName: string
Title:
Name
Maximum Length:240
Name of the grade ladder. -
grades: array
Grade Ladders Grades
Title:
Grade Ladders Grades
The grades resource is a child of the gradeLadders resource. It identifies the grades in the ladder, along with the sequence of the grades. -
GradeSetId: integer
(int64)
Surrogate identifier for the set to which the grades in the grade ladder belong.
-
GradeType: string
Maximum Length:
30
Indicates whether the grades in the grade ladder have steps. A value of GRADE means that the grades don't have steps. A value of STEP means that the grades have steps. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
stepRates: array
Grade Ladders Step Rates
Title:
Grade Ladders Step Rates
The stepRates resource is a child of the gradeLadders resource and provides the step rate details including currency, frequency, and annualization factor.
Nested Schema : Grade Ladders Grades
Type:
array
Title:
Grade Ladders Grades
The grades resource is a child of the gradeLadders resource. It identifies the grades in the ladder, along with the sequence of the grades.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Grade Ladders Step Rates
Type:
array
Title:
Grade Ladders Step Rates
The stepRates resource is a child of the gradeLadders resource and provides the step rate details including currency, frequency, and annualization factor.
Show Source
Nested Schema : gradeLadders-gradeLadderDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
GradeLadderId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : gradeLadders-grades-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the period within which the grade is effective in a grade ladder. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the grade is effective in a grade ladder. -
GradeId: integer
(int64)
Surrogate identifier for the grade.
-
GradesInLadderSequence: integer
(int64)
Sequence of the grade in a grade ladder.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : gradeLadders-stepRates-item-response
Type:
Show Source
object
-
ActiveStatus: string
Maximum Length:
30
Active status of the step rate. -
AnnualizationFactor: number
Annualization factor used to convert the step rate values to an annual amount.
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
Code of the currency associated with the step rate. -
EffectiveEndDate: string
(date)
Effective end date of the step rate.
-
EffectiveStartDate: string
(date)
Effective start date of the step rate.
-
LegislationCode: string
Maximum Length:
30
Legislation code of the step rate. -
LegislativeDataGroupId: integer
(int64)
Surrogate identifier for the legislative data group of the step rate.
-
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 for the step rate.
-
RateName: string
Title:
Name
Maximum Length:240
Name of the step rate. -
RateType: string
Maximum Length:
30
Type of rate such as salary or bonus. Values come from the GRADE_PAY_RATE_TYPE lookup. -
stepRateValues: array
Grade Ladders Step Rate Values
Title:
Grade Ladders Step Rate Values
The stepRateValues resource is a child of the gradeLadders resource and provides the value amounts for the steps in the step rate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Grade Ladders Step Rate Values
Type:
array
Title:
Grade Ladders Step Rate Values
The stepRateValues resource is a child of the gradeLadders resource and provides the value amounts for the steps in the step rate.
Show Source
Nested Schema : gradeLadders-stepRates-stepRateValues-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the step rate values record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the step rate values record. -
GradeStepId: integer
Surrogate identifier for the grade step defined in the step rate values record.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RateValueId: integer
(int64)
Surrogate identifier for the step rate value record.
-
StepRateValueAmount: number
The rate value for the grade step defined in the step rate values record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all grade ladders 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/
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.
{ "items": [ { "GradeLadderId": 100000011571500, "EffectiveStartDate": "2009-07-27", "EffectiveEndDate": "4712-12-31", "GradeLadderName": "CDRM Grade Ladder 1", "ActionReasonCode": null, "GradeSetId": 0, "GradeType": "GRADE", "ActiveStatus": "A", "links": { ...} }, { "GradeLadderId": 100000011571506, "EffectiveStartDate": "2009-07-27", "EffectiveEndDate": "4712-12-31", "GradeLadderName": "CDRM Grade Ladder 2", "ActionReasonCode": null, "GradeSetId": 0, "GradeType": "GRADE", "ActiveStatus": "A", "links": [ { ...} }