Title for the GET standard action on a singleton defined on payrollTimePeriodsLOV root resource.
get
/hcmRestApi/resources/11.13.18.05/payrollTimePeriodsLOV/{payrollTimePeriodsLOVUniqID}
Request
Path Parameters
-
payrollTimePeriodsLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TimePeriodId, PayrollId, EffectiveStartDate and EffectiveEndDate ---for the Payroll Time Periods List of Values resource and used to uniquely identify an instance of Payroll Time Periods List of Values. The client should not generate the hash key value. Instead, the client should query on the Payroll Time Periods List of Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Payroll Time Periods List of Values.
For example: payrollTimePeriodsLOV?q=TimePeriodId=<value1>;PayrollId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
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
-
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 : payrollTimePeriodsLOV-item-response
Type:
Show Source
object
-
DefaultPaydate: string
(date)
Title:
Date Paid
Read Only:true
Date on which the employee will be paid. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
Date at the end of the period during which the payroll definition is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
Date at the beginning of the period during which the payroll definition is effective. -
EndDate: string
(date)
Title:
End Date
Read Only:true
End date of the payroll period. -
LegislativeDataGroupId: integer
(int64)
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. -
PayrollId: integer
(int64)
Title:
Payroll ID
Read Only:true
Unique identifier of the payroll definition for the time period. -
PayrollName: string
Title:
Payroll Name
Read Only:true
Maximum Length:80
Code that uniquely identifies the payroll definition for which the time period is defined. -
PayslipViewDate: string
(date)
Title:
Payslip Availability Date
Read Only:true
Date on which the employee can view their payslip. -
PeriodCategory: string
Read Only:
true
Maximum Length:30
Identifier to decide if the period is an earning, deduction, or statutory period. -
PeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:70
Name of the payroll period. -
PeriodNumber: integer
(int64)
Title:
Period Number
Read Only:true
Counter to track the number of the payroll period generated in a given cycle. -
PeriodType: string
Title:
Period Type
Read Only:true
Maximum Length:30
Frequency at which the period is generated. -
RegularEarnDate: string
(date)
Title:
Regular Date Earned
Read Only:true
Date used to identify which element entries are included in the payroll run. -
RegularProcessDate: string
(date)
Title:
Regular Process Date
Read Only:true
Date on which the payroll will be calculated. -
StartDate: string
(date)
Title:
Payroll Period Start Date
Read Only:true
Start date of the payroll period. -
TimePeriodId: integer
(int64)
Read Only:
true
Surrogate identifier of the payroll time period.
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.
Examples
The following example shows how to retrieve a payroll time period using PayrollName
, PeriodName
, and PeriodCategory
, 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/payrollTimePeriodsLOV?q=PayrollName=' ZHRX-SG-GI-NOCTG-Monthly' and PeriodName='1 2011 Monthly Calendar' and PeriodCategory='E'"
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": [ { "TimePeriodId": 300100039196377, "StartDate": "2011-01-01", "EndDate": "2011-01-31", "PeriodCategory": "E", "PeriodName": "1 2011 Monthly Calendar", "PeriodNumber": 1, "PeriodType": "Calendar Month", "RegularProcessDate": "2011-01-31", "RegularEarnDate": "2011-01-31", "DefaultPaydate": "2011-01-31", "PayslipViewDate": "2011-01-31", "PayrollName": " ZHRX-SG-GI-NOCTG-Monthly", "PayrollId": 300100039196374, "EffectiveStartDate": "2011-01-01", "EffectiveEndDate": "4712-12-31", "LegislativeDataGroupId": 300100007642178, "LegislativeDataGroupName": "ZHRX-SG-LDG001", "links" : [ { ....} ] }