Get a payroll balance definition
/hcmRestApi/resources/11.13.18.05/payrollBalanceDefinitionsLOV/{BalanceTypeId}
Request
-
BalanceTypeId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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).
-
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
- application/json
Default Response
-
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.
object
-
ApplicationId: integer
(int64)
Read Only:
true
Unique identifier for the application. -
BalanceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the payroll balance. -
BalanceTypeId: integer
(int64)
Read Only:
true
Surrogate identifier for the payroll balance definition. -
BaseBalanceName: string
Read Only:
true
Maximum Length:80
Unique code that identifies the balance. -
LegislationCode: string
Title:
Country
Read Only:true
Maximum Length:30
Unique code that identifies the legislation. -
LegislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group
Read Only:true
Unique identifier for the legislative data group. -
LegislativeDataGroupName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the legislative data group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReportingName: string
Title:
Reporting Name
Read Only:true
Maximum Length:80
Name of the payroll balance that's displayed on reports and pay advice instead of the actual name. -
UserCategoryName: string
Read Only:
true
Maximum Length:80
Name of the balance category.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following examples show how to retrieve a payroll balance definition by submitting a GET request on the REST resource using cURL.
Use a Query Parameter
In this
example, the query parameter BalanceTypeId
is used to retrieve a payroll balance definition. The following
is an example of the cURL command.
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/payrollBalanceDefinitionsLOV?q=BalanceTypeId=300100128818047"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items" : [ { "BalanceTypeId" : 300100128818047, "BaseBalanceName" : "A01_CHILD_SUPPORT", "BalanceName" : "A01_CHILD_SUPPORT", "ReportingName" : "A01_CHILD_SUPPORT", "ApplicationId" : null, "LegislativeDataGroupId" : 300100001794247, "LegislationCode" : null, "UserCategoryName" : "Involuntary Deductions", "LegislativeDataGroupName" : "ZHRX_USVS_ST LDG One", "links" : [ { ....} ] }
Use a Finder
In this example,
the finder findByWord
is
used with the finder variables SearchTerms
and FilterAttributes
to
retrieve payroll balance definitions that match the specified criteria.
The following is an example of the cURL command.
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/payrollBalanceDefinitionsLOV?finder=findByWord;SearchTerms=AAG_Annual_Sal,FilterAttributes=BalanceName"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "BalanceTypeId": 300100197398945, "BaseBalanceName": "AAG_Annual_Sal", "BalanceName": "AAG_Annual_Sal", "ReportingName": "AAG_Annual_Sal", "ApplicationId": null, "LegislativeDataGroupId": 300100025776039, "LegislationCode": null, "UserCategoryName": "Earnings", "LegislativeDataGroupName": "CRFL RRF LDG US1", "links" : [ { ....} ] }