Get all salary bases
get
/hcmRestApi/resources/11.13.18.05/salaryBasisLov
Request
Query Parameters
-
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 salary bases that match the specified primary key criteria.
Finder Variables- SalaryBasisId; integer; Unique identifier of the salary basis.
- findByBasisCode Finds all salary bases that match the specified criteria.
Finder Variables- Code; string; User-defined code for the salary basis.
- EffectiveDate; string; Date used to find the salary basis.
- findByLegalEmployerName Finds all legal employers that match the specified criteria.
Finder Variables- EffectiveDate; string; Date used to find the salary basis.
- LegalEmployerName; string; Name of the legal employer.
- findByLegalEntityId Finds all legal entities that match the specified criteria.
Finder Variables- EffectiveDate; string; Date used to find the salary basis.
- LegalEntityId; integer; Unique identifier of the legal entity.
- findByLegislativeDataGroup Finds all legislative data groups that match the specified criteria.
Finder Variables- EffectiveDate; string; Date used to find the salary basis.
- LegislativeDataGroupId; integer; Unique identifier of the legislative data group.
- findBySalaryBasisId Finds all salary bases that match the specified criteria.
Finder Variables- EffectiveDate; string; Date used to find the salary basis.
- SalaryBasisId; integer; Unique identifier of the salary basis.
- findByWord Finds all salary bases that match the specified criteria.
Finder Variables- AsgLevel; string; Level of the associated payroll element, such as Assignment or Terms.
- EffectiveDate; string; Date used to find the salary basis.
- FilterAttributes; string; Attributes used to filter the salary basis, such as SalaryBasisName and FrequencyName.
- LegislativeDataGroupId; integer; Unique identifier of the legislative data group.
- SearchTerms; string; User-entered term in the Salary Basis field, such as Annual.
- Status; string; Status; string; of the salary basis, such as Active or Inactive.
- PrimaryKey Finds all salary bases that match the specified primary key criteria.
-
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:- AnnualizationFactor; number; Multiplier that converts the salary amount to an annual salary amount. For example, if a worker's base pay is quoted hourly, the annualization factor is 2080 (40 hours per week x 52 weeks).
- Code; string; User-defined code for the salary basis.
- ComponentUsage; string; Indicates that incremental salary components are available for managers to use when adjusting salary.
- ElementTypeId; integer; Unique identifier of the element type.
- FrequencyCode; string; Code of the salary basis frequency, such as ANNUAL, MONTHLY, HOURLY.
- FrequencyName; string; Frequency of the salary basis such as Annually, Monthly, Weekly, or Hourly.
- GradeRateId; integer; Unique identifier of the grade rate.
- InputCurrencyCode; string; Currency that salary amount is stored in, such as US Dollar.
- LegislativeDataGroupId; integer; Unique identifier of the legislative data group.
- SalaryAmountScale; number; Number of decimal places to display for salary amounts.
- SalaryBasisId; integer; Numeric identifier for the set of details linked to a worker's base pay.
- SalaryBasisName; string; Unique name for the set of details linked to a worker's base pay.
- SalaryBasisType; string; Type of the salary basis, such as salary amount determined by user or components.
- Status; string; Status of the salary basis, such as Active or Inactive.
- UseAtAssignmentLevel; string; Indicates that the salary basis choice list is available at the assignment level.
- UseAtRelationshipLevel; string; Indicates that the salary basis choice list is available at the relationship level.
- UseAtTermsLevel; string; Indicates that the salary basis choice list is available at the terms level.
-
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
-
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 : salaryBasisLov
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 : salaryBasisLov-item-response
Type:
Show Source
object
-
AnnualizationFactor: number
Read Only:
true
Multiplier that converts the salary amount to an annual salary amount. For example, if a worker's base pay is quoted hourly, the annualization factor is 2080 (40 hours per week x 52 weeks). -
Code: string
Read Only:
true
Maximum Length:80
User-defined code for the salary basis. -
ComponentUsage: string
Read Only:
true
Maximum Length:30
Indicates that incremental salary components are available for managers to use when adjusting salary. -
ElementTypeId: integer
(int64)
Read Only:
true
Unique identifier of the element type. -
FrequencyCode: string
Read Only:
true
Maximum Length:30
Code of the salary basis frequency, such as ANNUAL, MONTHLY, HOURLY. -
FrequencyName: string
Read Only:
true
Maximum Length:80
Frequency of the salary basis such as Annually, Monthly, Weekly, or Hourly. -
GradeRateId: integer
(int64)
Read Only:
true
Unique identifier of the grade rate. -
InputCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency that salary amount is stored in, such as US Dollar. -
LegislativeDataGroupId: integer
(int64)
Read Only:
true
Unique identifier of the legislative data group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SalaryAmountScale: number
Read Only:
true
Number of decimal places to display for salary amounts. -
salaryBasisComponents: array
Salary Basis Components
Title:
Salary Basis Components
A child of the salaryBasisLov resource, this resource itemizes salary adjustments into different reasons, such as merit, adjustment, and location. Component itemization is for reporting purposes only. -
SalaryBasisId: integer
(int64)
Read Only:
true
Numeric identifier for the set of details linked to a worker's base pay. -
SalaryBasisName: string
Read Only:
true
Maximum Length:255
Unique name for the set of details linked to a worker's base pay. -
SalaryBasisType: string
Read Only:
true
Maximum Length:30
Type of the salary basis, such as salary amount determined by user or components. -
Status: string
Read Only:
true
Maximum Length:30
Status of the salary basis, such as Active or Inactive. -
UseAtAssignmentLevel: string
Read Only:
true
Maximum Length:30
Indicates that the salary basis choice list is available at the assignment level. -
UseAtRelationshipLevel: string
Read Only:
true
Maximum Length:30
Indicates that the salary basis choice list is available at the relationship level. -
UseAtTermsLevel: string
Read Only:
true
Maximum Length:30
Indicates that the salary basis choice list is available at the terms level.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Salary Basis Components
Type:
array
Title:
Salary Basis Components
A child of the salaryBasisLov resource, this resource itemizes salary adjustments into different reasons, such as merit, adjustment, and location. Component itemization is for reporting purposes only.
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 : salaryBasisLov-salaryBasisComponents-item-response
Type:
Show Source
object
-
AttributeValue: string
Read Only:
true
Maximum Length:30
Salary basis component, such as Merit, Adjustment, or Location, used to itemize a salary adjustment into one of many different reasons for reporting purposes only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupUsageId: integer
(int64)
Read Only:
true
Unique identifier of the salary basis component.
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 salary basis by submitting a GET request on the REST resource using cURL.
curl -i -u ""<username>:<password> -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET " https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov"
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.
<Include response>{ "items": [ { "SalaryBasisName": "GSP Hourly", "SalaryBasisId": 300100113113203, "FrequencyCode": "HOURLY", "FrequencyName": "Hourly", "Code": "GSP_Hourly", "Status": "A", "SalaryBasisType": "U", "ComponentUsage": "NO_COMPONENT", "AnnualizationFactor": 2080, "SalaryAmountScale": 2, "GradeRateId": 300100113113290, "InputCurrencyCode": "USD", "ElementTypeId": 300100113110831, "LegislativeDataGroupId": 100010027007985, "UseAtRelationshipLevel": "N", "UseAtTermsLevel": "N", "UseAtAssignmentLevel": "Y", "links": [ { "rel": "self", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F080A3A073", "name": "salaryBasisLov", "kind": "item" }, { "rel": "canonical", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F080A3A073", "name": "salaryBasisLov", "kind": "item" }, { "rel": "child", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F080A3A073/child/salaryBasisComponents", "name": "salaryBasisComponents", "kind": "collection" } ] }, { "SalaryBasisName": "GSP Monthly", "SalaryBasisId": 300100112568682, "FrequencyCode": "MONTHLY", "FrequencyName": "Monthly", "Code": "GSP_Monthly", "Status": "A", "SalaryBasisType": "U", "ComponentUsage": "NO_COMPONENT", "AnnualizationFactor": 12, "SalaryAmountScale": 2, "GradeRateId": 300100112568562, "InputCurrencyCode": "USD", "ElementTypeId": 300100113074709, "LegislativeDataGroupId": 100010027007985, "UseAtRelationshipLevel": "N", "UseAtTermsLevel": "N", "UseAtAssignmentLevel": "Y", "links": [ { "rel": "self", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0809B516A", "name": "salaryBasisLov", "kind": "item" }, { "rel": "canonical", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0809B516A", "name": "salaryBasisLov", "kind": "item" }, { "rel": "child", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0809B516A/child/salaryBasisComponents", "name": "salaryBasisComponents", "kind": "collection" } ] }, ... { "SalaryBasisName": "SB_082917_SAADC_W3_T0059", "SalaryBasisId": 300100123242860, "FrequencyCode": "WEEK", "FrequencyName": "Weekly", "Code": "SB_082917_SAADC_W3_T0059", "Status": "A", "SalaryBasisType": "C", "ComponentUsage": "USER_DECIDES_USAGE", "AnnualizationFactor": 52, "SalaryAmountScale": 3, "GradeRateId": 300100123206951, "InputCurrencyCode": "USD", "ElementTypeId": 300100123248097, "LegislativeDataGroupId": 100010027007985, "UseAtRelationshipLevel": "N", "UseAtTermsLevel": "N", "UseAtAssignmentLevel": "Y", "links": [ { "rel": "self", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316C", "name": "salaryBasisLov", "kind": "item" }, { "rel": "canonical", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316C", "name": "salaryBasisLov", "kind": "item" }, { "rel": "child", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316C/child/salaryBasisComponents", "name": "salaryBasisComponents", "kind": "collection" } ] }, { "SalaryBasisName": "SB_082917_SAADC_W3_T0061", "SalaryBasisId": 300100123242862, "FrequencyCode": "WEEK", "FrequencyName": "Weekly", "Code": "SB_082917_SAADC_W3_T0061", "Status": "A", "SalaryBasisType": "C", "ComponentUsage": "SELECTED_COMPONENTS", "AnnualizationFactor": 52, "SalaryAmountScale": 3, "GradeRateId": 300100123206951, "InputCurrencyCode": "USD", "ElementTypeId": 300100123248097, "LegislativeDataGroupId": 100010027007985, "UseAtRelationshipLevel": "N", "UseAtTermsLevel": "N", "UseAtAssignmentLevel": "Y", "links": [ { "rel": "self", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316E", "name": "salaryBasisLov", "kind": "item" }, { "rel": "canonical", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316E", "name": "salaryBasisLov", "kind": "item" }, { "rel": "child", "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001677683AC00780000000EACED00057708000110F0813E316E/child/salaryBasisComponents", "name": "salaryBasisComponents", "kind": "collection" } ] }