Oracle Fusion HCM endpoint reference

Workers REST API

Get all workers

GET https://your-pod.oraclecloud.com/hcmRestApi/resources/11.13.18.05/workers

Everything on this page is extracted from Oracle's official OpenAPI specification for Fusion Cloud HCM: 307 queryable q fields, 3 named finders, and 20 child resources. Unsure how q works? See the Oracle HCM API guide.

Supported operations

GET /workers
GET /workers/{id}
PATCH /workers/{id}
POST /workers

Finders (3)

Finders are named, pre-built queries with bound parameters. They can search values plain q filters cannot reach.

Finder Bind variables
Employee E (string)
Worker C (string)
Nonworker N (string)

Example finder request

GET /hcmRestApi/resources/11.13.18.05/workers?finder=Employee;E=<value>

Queryable q fields (307)

Only these fields can appear in a q filter expression on /workers. Filtering on any other field returns 400 Bad Request.

Example q request

GET /hcmRestApi/resources/11.13.18.05/workers?q=EmailAddressId='<value>'&onlyData=true&limit=25
Field Type Operators
EmailAddressId string = !=
ReligionId string = !=
AssignGradeStepId integer = !=
CreatedBy string = !=
CreationDate string = !=
EffectiveEndDate string = !=
EffectiveStartDate string = !=
GradeStepId integer = !=
GradeStepName string = !=
LastUpdateDate string = !=
LastUpdatedBy string = !=
PhotoName string = !=
PhotoType string = !=
PrimaryFlag boolean = !=
ExpirationDate string = !=
IssuingCountry string = !=
IssuingCountryName string = !=
PassportId integer = !=
PassportNumber string = !=
PassportType string = !=
PassportTypeMeaning string = !=
AsgResponsibilityId integer = !=
AssignmentId integer = !=
AssignmentName string = !=
AssignmentNumber string = !=
DisplayName string = !=
PersonId integer = !=
PersonNumber string = !=
ResponsibilityName string = !=
ResponsibilityType string = !=
Usage string = !=
WorkContactsFlag boolean = !=
PersonAddrUsageId string = !=
ImageId string = !=
DeliveryMethodId string = !=
AddressId integer = !=
AddressType string = !=
AddressTypeMeaning string = !=
Building string = !=
Country string = !=
CountryName string = !=
FloorNumber string = !=
Latitude number between
LongPostalCode string = !=
Longitude number between
PostalCode string = !=
Provider string = !=
Region1 string = !=
Region2 string = !=
Region3 string = !=
TownOrCity string = !=
ValidationStatusCode string = !=
Ethnicity string = !=
EthnicityId integer = !=
EthnicityMeaning string = !=
LegislationCode string = !=
LegislationName string = !=
ManagerAssignmentId integer = !=
ManagerAssignmentNumber string = !=
ManagerType string = !=
FirstName string = !=
FullName string = !=
Honors string = !=
KnownAs string = !=
LastName string = !=
ListName string = !=
LocalCreatedBy string = !=
LocalCreationDate string = !=
LocalDisplayName string = !=
LocalEffectiveEndDate string = !=
LocalEffectiveStartDate string = !=
LocalFirstName string = !=
LocalFullName string = !=
LocalHonors string = !=
LocalKnownAs string = !=
LocalLastName string = !=
LocalLastUpdateDate string = !=
LocalLastUpdatedBy string = !=
LocalLegislationCode string = !=
LocalLegislationName string = !=
LocalListName string = !=
LocalMiddleNames string = !=
LocalMilitaryRank string = !=
LocalNameInformation1 string = !=
LocalNameInformation10 string = !=
LocalNameInformation11 string = !=
LocalNameInformation12 string = !=
LocalNameInformation13 string = !=
LocalNameInformation14 string = !=
LocalNameInformation15 string = !=
LocalNameInformation16 string = !=
LocalNameInformation17 string = !=
LocalNameInformation18 string = !=
LocalNameInformation19 string = !=
LocalNameInformation2 string = !=
LocalNameInformation20 string = !=
LocalNameInformation21 string = !=
LocalNameInformation22 string = !=
LocalNameInformation23 string = !=
LocalNameInformation24 string = !=
LocalNameInformation25 string = !=
LocalNameInformation26 string = !=
LocalNameInformation27 string = !=
LocalNameInformation28 string = !=
LocalNameInformation29 string = !=
LocalNameInformation3 string = !=
LocalNameInformation30 string = !=
LocalNameInformation4 string = !=
LocalNameInformation5 string = !=
LocalNameInformation6 string = !=
LocalNameInformation7 string = !=
LocalNameInformation8 string = !=
LocalNameInformation9 string = !=
LocalNameLanguage string = !=
LocalNameLanguageMeaning string = !=
LocalOrderName string = !=
LocalPersonNameId integer = !=
LocalPreNameAdjunct string = !=
LocalPreviousLastName string = !=
LocalSuffix string = !=
LocalTitle string = !=
LocalTitleMeaning string = !=
MiddleNames string = !=
MilitaryRank string = !=
NameInformation1 string = !=
NameInformation10 string = !=
NameInformation11 string = !=
NameInformation12 string = !=
NameInformation13 string = !=
NameInformation14 string = !=
NameInformation15 string = !=
NameInformation16 string = !=
NameInformation17 string = !=
NameInformation18 string = !=
NameInformation19 string = !=
NameInformation2 string = !=
NameInformation20 string = !=
NameInformation21 string = !=
NameInformation22 string = !=
NameInformation23 string = !=
NameInformation24 string = !=
NameInformation25 string = !=
NameInformation26 string = !=
NameInformation27 string = !=
NameInformation28 string = !=
NameInformation29 string = !=
NameInformation3 string = !=
NameInformation30 string = !=
NameInformation4 string = !=
NameInformation5 string = !=
NameInformation6 string = !=
NameInformation7 string = !=
NameInformation8 string = !=
NameInformation9 string = !=
NameLanguage string = !=
NameLanguageMeaning string = !=
OrderName string = !=
PersonNameId integer = !=
PreNameAdjunct string = !=
PreviousLastName string = !=
Suffix string = !=
Title string = !=
TitleMeaning string = !=
PersonLegislativeId string = !=
VisaPermitId string = !=
LegalEmployerName string = !=
LegalEntityId integer = !=
PeriodOfServiceId integer = !=
ProjectedTerminationDate string = !=
ReadyToConvertFlag boolean = !=
StartDate string = !=
TerminationDate string = !=
WorkerType string = !=
AreaCode string = !=
CountryCodeNumber string = !=
Extension string = !=
PhoneId integer = !=
PhoneNumber string = !=
PhoneType string = !=
PhoneTypeMeaning string = !=
ToDate string = !=
Validity string = !=
ValidityMeaning string = !=
FromDate string = !=
MessageContent string = !=
MessageId integer = !=
EmailAddress string = !=
EmailType string = !=
EmailTypeMeaning string = !=
ApplicantNumber string = !=
BloodTypeMeaning string = !=
CorrLanguageMeaning string = !=
CountryOfBirthName string = !=
DateOfBirth string = !=
AccommodationRequest string = !=
Category string = !=
Degree number = !=
Description string = !=
DisabilityCode string = !=
DisabilityId integer = !=
DisclosureDate string = !=
OrganizationId integer = !=
OrganizationName string = !=
QuotaFTE number = !=
Reason string = !=
RegistrationDate string = !=
RegistrationExpDate string = !=
RegistrationId string = !=
SelfDisclosedType string = !=
Status string = !=
WorkRestriction string = !=
Level integer = !=
RelationshipType string = !=
AssignmentType string = !=
EffectiveLatestChange string = !=
EffectiveSequence string = !=
Religion string = !=
ReligionMeaning string = !=
ContractId string = !=
NationalIdentifierId string = !=
DriversLicenseId integer = !=
LicenseNumber string = !=
LicenseSuspendedFlag boolean = !=
LicenseType string = !=
LicenseTypeMeaning string = !=
SuspendedFromDate string = !=
SuspendedToDate string = !=
ActionCode string = !=
AssignmentCategory string = !=
AssignmentStatusType string = !=
BargainingUnitCode string = !=
BusinessUnitId integer = !=
BusinessUnitName string = !=
CollectiveAgreementId integer = !=
CollectiveAgreementName string = !=
ContractNumber string = !=
DefaultExpenseAccount string = !=
DepartmentId integer = !=
DepartmentName string = !=
FullPartTime string = !=
GradeCode string = !=
GradeId integer = !=
GradeLadderId integer = !=
GradeLadderName string = !=
GradeStepEligibilityFlag boolean = !=
HourlySalariedCode string = !=
JobCode string = !=
JobId integer = !=
LabourUnionMemberFlag boolean = !=
LocationCode string = !=
LocationId integer = !=
ManagerFlag boolean = !=
NoticePeriod integer = !=
NoticePeriodUOM string = !=
PeopleGroup string = !=
PermanentTemporary string = !=
PositionCode string = !=
PositionId integer = !=
PrimaryAssignmentFlag boolean = !=
ProbationEndDate string = !=
ProbationPeriod number = !=
ProbationPeriodUnit string = !=
ProjectedEndDate string = !=
ProjectedStartDate string = !=
ProposedUserPersonType string = !=
ProposedUserPersonTypeId string = !=
ReportingEstablishmentId integer = !=
ReportingEstablishmentName string = !=
RetirementAge integer = !=
RetirementDate string = !=
SeniorityBasis string = !=
SynchronizeFromPositionFlag boolean = !=
UnionId integer = !=
UnionName string = !=
UserPersonTypeId integer = !=
WorkAtHomeFlag boolean = !=
WorkerCategory string = !=
AccountName string = !=
EndDate string = !=
ProviderMeaning string = !=
Citizenship string = !=
CitizenshipId integer = !=
CitizenshipMeaning string = !=
CitizenshipStatus string = !=
CitizenshipStatusMeaning string = !=
ExternalIdentifierId integer = !=
ExternalIdentifierNumber string = !=
ExternalIdentifierSequence integer = !=
ExternalIdentifierType string = !=
ExternalIdentifierTypeMeaning string = !=
VisaPermitCategory string = !=
VisaPermitCategoryMeaning string = !=
VisaPermitNumber string = !=
VisaPermitStatus string = !=
VisaPermitStatusDate string = !=
VisaPermitStatusMeaning string = !=
VisaPermitType string = !=
VisaPermitTypeMeaning string = !=
ContractEndDate string = !=
ContractExtensionFlag boolean = !=
ContractType string = !=
ExtensionNumber integer = !=
ExtensionPeriod number = !=
ExtensionPeriodUnits string = !=
InitialDuration number = !=
InitialDurationUnits string = !=
DriversLicenseTypeId string = !=

Child resources (20)

Each child is reachable at /workers/{id}/child/<name> and most can also be inlined with expand.

addressescitizenshipsdisabilitiesdriverLicensesemailsethnicitiesexternalIdentifierslegislativeInfomessagesnamesnationalIdentifiersotherCommunicationAccountspassportsphonesphotosreligionsvisasPermitsworkRelationshipsworkersDFFworkersEFF

Response fields (40)

Top-level attributes returned for each row. Use fields= to request a subset and shrink the payload.

ApplicantNumberBloodTypeBloodTypeMeaningCorrLanguageMeaningCorrespondenceLanguageCountryOfBirthCountryOfBirthNameCreatedByCreationDateDateOfBirthDateOfDeathDisplayNameFullNameLastUpdateDateLastUpdatedByListNamePersonIdPersonNumberRegionOfBirthTownOfBirthaddressescitizenshipsdisabilitiesdriverLicensesemailsethnicitiesexternalIdentifierslegislativeInfomessagesnamesnationalIdentifiersotherCommunicationAccountspassportsphonesphotosreligionsvisasPermitsworkRelationshipsworkersDFFworkersEFF

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