Get
/hcm-rest-api/rest/1/pyemphist
Query Standards
Finder
Following row finders are available for data filtering and optimizing request performance.
- Py Employee Finder
- Find By Date
- Select By Term
- Select By Type
- Select By Pay Run
- Select By Status
- By UUID
Py Employee Finder
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| EmpNoVar | Employee Number | 0066 |
| EmpTermDate | Employment Term Date | 2015-12-20 |
| EmpPrnVar | Employee Payrun Code | WK |
| EmpTypeVar | Employment Type Code | H |
| EmpStatusVar | Employment Status Code | A |
Find By Date
This is an optional finder for querying Employees by Audit Date and Company Code.
| Parameter | Description | Sample |
|---|---|---|
| auditDate | Create or Update Date Time Filter | 2015-12-20 |
| compCode | Company Code | 001 |
Select By Term
This is an optional finder for querying Employees by Employment Term Date.
| Parameter | Description | Sample |
|---|---|---|
| EmpTermDate | Employment Term Date | 2015-12-20 |
Select By Type
This is an optional finder for querying Employees by Employment Type Code.
| Parameter | Description | Sample |
|---|---|---|
| EmpTypeVar | Employment Type Code | H |
Select By Pay Run
This is an optional finder for querying Employees by Employee Payrun Code.
| Parameter | Description | Sample |
|---|---|---|
| EmpPrnVar | Employee Payrun Code | WK |
Select By Status
This is an optional finder for querying Employees by Employment Status Code.
| Parameter | Description | Sample |
|---|---|---|
| EmpStatusVar | Employment Status Code | A |
By UUID
This is an optional finder for querying a specific Employee by row ID.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | /hcm-rest-api/rest/1/pyemployee/EFBC72D625223E23E05316821FAC0EFB |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExamplefindByEmp;empNo=MS-000016,effDateTo=2024-11-11
limit
integer
Example1
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
"items": [
{
"EmhSeqNo": 2147484836,
"EmhEmpNo": "MS-000016",
"EmhFullName": "B hourly Tim",
"EmhActionCode": "CH",
"EmhEffectiveDate": "2024-10-25",
"EmhTxtCode": "1",
"EmhLastName": "B hourly",
"EmhFirstName": "Tim",
"EmhMiddleName": null,
"EmhPrefixName": null,
"EmhSuffixName": null,
"EmhNickName": null,
"EmhSinNo": "700800909",
"EmhEmpType": "S",
"EmhFullPartTime": "F",
"EmhStatus": "A",
"EmhSubStatusCode": "LS",
"EmhCalcAccruedLeave": "Y",
"EmhFlsaType": "E",
"EmhEmpUnionized": "Y",
"EmhMembershipDate": null,
"EmhRehireEligible": "Y",
"EmhUnionCode": "NYL",
"EmhUnionMemNo": null,
"EmhJobTitle": null,
"EmhPlaceOfBirth": null,
"EmhDateOfBirth": "1980-07-18",
"EmhSeniorityDate": null,
"EmhNextReviewDate": null,
"EmhAdjustedSeriviceDate": "2020-03-05",
"EmhServiceYears": 0,
"EmhYearWorkingDays": null,
"EmhYearWorkingHours": null,
"EmhCompCode": "GL",
"EmhWcbCode": null,
"EmhHomeCompCode": "GL",
"EmhPlCode": null,
"EmhDepartmentCode": "00",
"EmhWcbByJob": "Y",
"EmhHomeDeptCode": "00",
"EmhPlByJob": "Y",
"EmhGlAccCode": "5200.105",
"EmhWrlFlag": "Y",
"EmhPayrollClearAccCode": "6900.101",
"EmhExcpInclFlag": "N",
"EmhDrClearAccCode": "6900.100",
"EmhInclCertPyRepFlag": "Y",
"EmhLevAcruGlAccCode": "6002.103",
"EmhAutogenerateTimesheet": "N",
"EmhLevClearAccCode": "6002.105",
"EmhDispatchFlag": "N",
"EmhPrnCode": "GLBW",
"EmhPayGroup": "HR",
"EmhWorkLocation": "NYC",
"EmhGrdCode": null,
"EmhTradeCode": "100",
"EmhExpAprvGrpCode": null,
"EmhTshCode": "GLBW",
"EmhCklocCode": "LOC1",
"EmhAnnualSalary": 120000,
"EmhPreferPayRate": "B",
"EmhHourRate": null,
"EmhPreferChargeRate": "P",
"EmhChargeRate": 92,
"EmhPreferBillRate": "T",
"EmhBillingRate": 0,
"EmhRateCode": "REG",
"EmhMinHourCode": null,
"EmhOtRateCode": "OT",
"EmhUserEnteredOt": "N",
"EmhDotRateCode": "DOT",
"EmhUserEnteredDt": "N",
"EmhOthRateCode": "REG",
"EmhJobCompCode": "GL",
"EmhEquipmentNo": null,
"EmhJobCode": null,
"EmhEquipPhsCode": null,
"EmhPhsCode": null,
"EmhEquipCategory": null,
"EmhCatCode": null,
"EmhEquipTranCode": null,
"EmhVertexGeocodeSource": "M",
"EmhAddressForeignFlag": "N",
"EmhAddress1": "121 Main Street",
"EmhPhAddressForeignFlag": "N",
"EmhPhAddress1": null,
"EmhAddress2": "apt 12",
"EmhPhAddress2": null,
"EmhAddress3": "Rochester",
"EmhPhAddress3": null,
"EmhZipCode": "10002",
"EmhPhZipCode": null,
"EmhEmpCountryCode": "US",
"EmhPhCountryCode": null,
"EmhResLatitude": null,
"EmhEmpStateCode": "NY",
"EmhPhStateCode": null,
"EmhResLongitude": null,
"EmhCountyCode": null,
"EmhCityCode": null,
"EmhPhone": null,
"EmhWorkPhone": null,
"EmhCellPhone": null,
"EmhBpCode": null,
"EmhPager": null,
"EmhPrefContactMth": "E",
"EmhFax": null,
"EmhWorkFax": null,
"EmhEmailAddress": null,
"EmhVertexGeocode": "330612010",
"EmhVertexSchdist": null,
"EmhResidentStatus": "C",
"EmhFilingStatus": "02",
"EmhStateFilingStatus": "02",
"EmhCityFilingStatus": null,
"EmhPrimExemp": null,
"EmhSecnExemp": null,
"EmhPrimExempAmt": null,
"EmhSuplExempAmt": null,
"EmhSuiState": null,
"EmhNrCertificate": "Y",
"EmhPensionFlag": "N",
"EmhDefCompFlag": "N",
"EmhAddrCompCode": null,
"EmhAddrCode": null,
"EmhRegionCode": null,
"EmhSex": "M",
"EmhPosCode": null,
"EmhMaritalStatus": "S",
"EmhDisabilityDisCode": null,
"EmhEthnicCode": "W",
"EmhTravelFlag": "N",
"EmhTravelDistance": 0,
"EmhMilitaryStatus": "NV",
"EmhLanguageLangName": null,
"EmhMilitarySeparationDate": null,
"EmhApplicantAplNo": null,
"EmhDominantHand": "R",
"EmhLoginUser": null,
"EmhLeaveCalcPref": "R",
"EmhHemplYearlySal": 0,
"EmhHemplType": "H",
"EmhCalcPref": "S",
"EmhComment": null,
"EmhHrrTypeCode": null,
"EmhTxtType": null,
"EmhResLoc": null,
"EmhUser": "DA",
"EmhLastUpdDate": "2024-10-25T16:20:51Z",
"EmhManualActivate": null,
"EmhBatchNo": null,
"EmhRefNo": null,
"EmhWorkProvince": null,
"EmhTertExemp": null,
"EmhHireDate": "2019-07-18",
"EmhReHireDate": "2020-07-08",
"EmhTerminationDate": null,
"EmhDateDeceased": null,
"EmhOtEligibility": null,
"EmhPaymentMode": null,
"EmhBankCode": null,
"EmhBranchCode": null,
"EmhBankAcNo": null,
"EmhLastIncrDate": null,
"EmhLastPromDate": null,
"EmhLastTranDate": null,
"EmhTd1ExempAmt": null,
"EmhTd1ProvExempAmt": null,
"EmhTd1ExempFlag": "N",
"EmhEiCode": null,
"EmhRegCompCode": null,
"EmhHardshipSuspFlag": "N",
"EmhEligibilityFlag": "N",
"EmhPlanNum1": null,
"EmhPlanNum2": null,
"EmhCheckPrefFlag": null,
"EmhHistLastAppliedDate": "2024-10-25",
"EmhLastTshJobCode": null,
"EmhAdpFilingStatus": "S",
"EmhEvent": "INSERT",
"EmhMachine": "HYOAHN10-L",
"EmhTerminal": "unknown",
"EmhDirectDepositInfo": null,
"EmhDirectDepMethod": "E",
"EmhDirectDepEmail": "Maryam.Seyfi@cmic.ca",
"EmhPositionCode": null,
"EmhReportsTo": null,
"EmhWorkEmailAddress": null,
"EmhWorkCellPhone": null,
"EmhFieldTrackingFlag": "N",
"EmhPensionNumber": null,
"EmhDisabledFlag": null,
"EmhAboriginalFlag": null,
"EmhVisibleMinorityFlag": null,
"EmhGcChargeRate": null,
"EmhGcBillRate": null,
"EmhTransferEmpLev": "N",
"EmhUkPayeTaxCode": null,
"EmhUkNicCategory": null,
"EmhUkTaxFrq": null,
"EmhUk1stPayComp": null,
"EmhUk1stPayRun": null,
"EmhUk1stPayYear": 0,
"EmhUk1stPayPeriod": 0,
"EmhUkStarterDeclaration": null,
"EmhUkPassportNo": null,
"EmhUkStudentFlag": "N",
"EmhUkPrvEmplrOfficeNum": null,
"EmhUkPrvEmplrPayeRef": null,
"EmhUkPrvEmplrLeaveDate": null,
"EmhUkPrvEmplrTaxCode": null,
"EmhUkPrvEmplrWm1Flag": "N",
"EmhUkPrvEmplrGrossAmt": null,
"EmhUkPrvEmplrTaxAmt": null,
"EmhUkSecondedFlag": "N",
"EmhUkEeaCitizenFlag": "N",
"EmhUkEpm6Flag": "N",
"EmhUkSecondedResidence": null,
"EmhIePayeExclusionFlag": "N",
"EmhIePrsiClassCategory": "A",
"EmhIeTaxrelief": null,
"EmhSalaryFrq": "A",
"EmhMonthlySalary": "A",
"EmhReligionCode": null,
"EmhAirportOraseq": null,
"EmhSchoolPercent": null,
"EmhContractType": null,
"EmhProbationDate": null,
"EmhPostGradLoanInd": null,
"EmhPostGradLoanType": null,
"EmhAutoWorkProvApply": "I",
"EmhAutoWorkProvApplyDesc": "Include",
"EmhExcludeHolidayTimesheet": "N",
"EmhVUuid": "254DD9E26C9C92EAE0630B811DACBA89",
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pyemphist/254DD9E26C9C92EAE0630B811DACBA89",
"name": "pyemphist",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pyemphist/254DD9E26C9C92EAE0630B811DACBA89",
"name": "pyemphist",
"kind": "item"
}
]
}
],
"count": 1,
"hasMore": true,
"limit": 1,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pyemphist",
"name": "pyemphist",
"kind": "collection"
}
]
}object