Supported operations
| GET /emps |
| GET /emps/{id} |
| PATCH /emps/{id} |
| POST /emps |
Queryable q fields (155)
Only these fields can appear in a q filter expression on
/emps. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/emps?q=ResponsibilityName='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| AsgResponsibilityId | integer | = != |
| AssignmentId | integer | = != |
| PersonId | integer | = != |
| ResponsibilityName | string | = != |
| ResponsibilityTypeCode | string | = != |
| ResponsibilityTypeName | string | = != |
| CreationDate | string | = != |
| EndDate | string | = != |
| LastUpdateDate | string | = != |
| RoleCommonName | string | = != |
| RoleGUID | string | = != |
| RoleName | string | = != |
| StartDate | string | = != |
| EnabledFlag | string | = != |
| EndDateActive | string | = != |
| StartDateActive | string | = != |
| _ID_FLEX_NUM | string | = != |
| _PEOPLE_GROUP_ID | string | = != |
| AddressLine1 | string | = != |
| AddressLine2 | string | = != |
| AddressLine3 | string | = != |
| CitizenshipId | integer | = != |
| CitizenshipLegislationCode | string | = != |
| CitizenshipStatus | string | = != |
| CitizenshipToDate | string | = != |
| City | string | = != |
| CorrespondenceLanguage | string | = != |
| Country | string | = != |
| DateOfBirth | string | = != |
| DisplayName | string | = != |
| DriversLicenseExpirationDate | string | = != |
| DriversLicenseId | integer | = != |
| DriversLicenseIssuingCountry | string | = != |
| EffectiveStartDate | string | = != |
| Ethnicity | string | = != |
| FirstName | string | = != |
| Gender | string | = != |
| HireDate | string | = != |
| HomeFaxAreaCode | string | = != |
| HomeFaxCountryCode | string | = != |
| HomeFaxExtension | string | = != |
| HomeFaxLegislationCode | string | = != |
| HomeFaxNumber | string | = != |
| HomePhoneAreaCode | string | = != |
| HomePhoneCountryCode | string | = != |
| HomePhoneExtension | string | = != |
| HomePhoneLegislationCode | string | = != |
| HomePhoneNumber | string | = != |
| Honors | string | = != |
| LastName | string | = != |
| LicenseNumber | string | = != |
| MaritalStatus | string | = != |
| MiddleName | string | = != |
| MilitaryVetStatus | string | = != |
| NameSuffix | string | = != |
| NationalId | string | = != |
| NationalIdCountry | string | = != |
| NationalIdExpirationDate | string | = != |
| NationalIdPlaceOfIssue | string | = != |
| NationalIdType | string | = != |
| PassportExpirationDate | string | = != |
| PassportId | integer | = != |
| PassportIssueDate | string | = != |
| PassportIssuingCountry | string | = != |
| PassportNumber | string | = != |
| PersonNumber | string | = != |
| PostalCode | string | = != |
| PreferredName | string | = != |
| PreviousLastName | string | = != |
| ProjectedTerminationDate | string | = != |
| Region | string | = != |
| Region2 | string | = != |
| Religion | string | = != |
| ReligionId | integer | = != |
| Salutation | string | = != |
| TerminationDate | string | = != |
| UserName | string | = != |
| WorkEmail | string | = != |
| WorkFaxAreaCode | string | = != |
| WorkFaxCountryCode | string | = != |
| WorkFaxExtension | string | = != |
| WorkFaxLegislationCode | string | = != |
| WorkFaxNumber | string | = != |
| WorkMobilePhoneAreaCode | string | = != |
| WorkMobilePhoneCountryCode | string | = != |
| WorkMobilePhoneExtension | string | = != |
| WorkMobilePhoneLegislationCode | string | = != |
| WorkMobilePhoneNumber | string | = != |
| WorkPhoneAreaCode | string | = != |
| WorkPhoneCountryCode | string | = != |
| WorkPhoneExtension | string | = != |
| WorkPhoneLegislationCode | string | = != |
| WorkPhoneNumber | string | = != |
| WorkerType | string | = != |
| FullName | string | = != |
| ManagerId | integer | = != |
| AssignmentType | string | = != |
| EffectiveEndDate | string | = != |
| EffectiveLatestChange | string | = != |
| EffectiveSequence | string | = != |
| ActionCode | string | = != |
| ActionReasonCode | string | = != |
| ActualTerminationDate | string | = != |
| AssignmentCategory | string | = != |
| AssignmentName | string | = != |
| AssignmentNumber | string | = != |
| AssignmentProjectedEndDate | string | = != |
| AssignmentStatus | string | = != |
| AssignmentStatusTypeId | integer | = != |
| BusinessUnitId | integer | = != |
| DepartmentId | integer | = != |
| EndTime | string | = != |
| Frequency | string | = != |
| FullPartTime | string | = != |
| GradeId | integer | = != |
| GradeLadderId | integer | = != |
| JobId | integer | = != |
| LegalEntityId | integer | = != |
| LocationId | integer | = != |
| ManagerAssignmentId | integer | = != |
| ManagerType | string | = != |
| OriginalHireDate | string | = != |
| PeopleGroup | string | = != |
| PeriodOfServiceId | integer | = != |
| PersonTypeId | integer | = != |
| PositionId | integer | = != |
| PrimaryAssignmentFlag | boolean | = != |
| PrimaryWorkRelationFlag | boolean | = != |
| PrimaryWorkTermsFlag | boolean | = != |
| ProbationPeriodEndDate | string | = != |
| ProbationPeriodLength | number | = != |
| ProbationPeriodUnitOfMeasure | string | = != |
| ProjectedStartDate | string | = != |
| ProposedPersonTypeId | string | = != |
| RegularTemporary | string | = != |
| SalaryAmount | number | = != |
| SalaryBasisId | integer | = != |
| SalaryCode | string | = != |
| StartTime | string | = != |
| TermsEffectiveStartDate | string | = != |
| WorkTaxAddressId | integer | = != |
| WorkerCategory | string | = != |
| WorkingAsManager | string | = != |
| WorkingAtHome | string | = != |
| WorkingHours | number | = != |
| VisaPermitCountry | string | = != |
| VisaPermitExpiration | string | = != |
| VisaPermitId | integer | = != |
| VisaPermitNumber | string | = != |
| VisaPermitType | string | = != |
| Image | string | = != |
| ImageId | integer | = != |
| ImageName | string | = != |
| ObjectVersionNumber | integer | = != |
| PrimaryFlag | boolean | = != |
Child resources (7)
Each child is reachable at
/emps/{id}/child/<name>
and most can also be inlined with expand.
assignmentsdirectReportspersonDFFpersonExtraInformationphotorolesvisas Response fields (87)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
AddressLine1AddressLine2AddressLine3CitizenshipIdCitizenshipLegislationCodeCitizenshipStatusCitizenshipToDateCityCorrespondenceLanguageCountryCreationDateDateOfBirthDisplayNameDriversLicenseExpirationDateDriversLicenseIdDriversLicenseIssuingCountryEffectiveStartDateEthnicityFirstNameGenderHireDateHomeFaxAreaCodeHomeFaxCountryCodeHomeFaxExtensionHomeFaxLegislationCodeHomeFaxNumberHomePhoneAreaCodeHomePhoneCountryCodeHomePhoneExtensionHomePhoneLegislationCodeHomePhoneNumberHonorsLastNameLastUpdateDateLegalEntityIdLicenseNumberMaritalStatusMiddleNameMilitaryVetStatusNameSuffixNationalIdNationalIdCountryNationalIdExpirationDateNationalIdPlaceOfIssueNationalIdTypePassportExpirationDatePassportIdPassportIssueDatePassportIssuingCountryPassportNumberPersonIdPersonNumberPostalCodePreferredNamePreviousLastNameProjectedTerminationDateRegionRegion2ReligionReligionIdSalutationTerminationDateUserNameWorkEmailWorkFaxAreaCodeWorkFaxCountryCodeWorkFaxExtensionWorkFaxLegislationCodeWorkFaxNumberWorkMobilePhoneAreaCodeWorkMobilePhoneCountryCodeWorkMobilePhoneExtensionWorkMobilePhoneLegislationCodeWorkMobilePhoneNumberWorkPhoneAreaCodeWorkPhoneCountryCodeWorkPhoneExtensionWorkPhoneLegislationCodeWorkPhoneNumberWorkerTypeassignmentsdirectReportspersonDFFpersonExtraInformationphotorolesvisas Build this query visually in OPAL
OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.
Related reference & reading
- /learnerLearningRecords Get all assignment records
- /absences Get all absence records
- /salaries Get all salaries for a worker's assignment
- /positions Get all positions
- /recruitingJobRequisitions Get all recruiting job requisitions
- Oracle HCM API guide
- Why the q parameter fails and how to fix it
- Finders: named queries in Oracle Fusion REST APIs
- All endpoint reference pages