1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Employees

Get all employees

get

/hcmRestApi/resources/11.13.18.05/emps

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all employees that match the primary key criteria specified.
      Finder Variables
      • CitizenshipId; integer; System-generated primary key. Surrogate key.
      • DriversLicenseId; integer; System-generated primary key. Surrogate key.
      • EffectiveStartDate; string; Effective start date for the employee record.
      • PassportId; integer; System-generated primary key. Surrogate key.
      • PersonId; integer; Internal identifier for the person.
      • ReligionId; integer; System-generated primary key. Surrogate key.
    • findByAssignmentAttr Finds all employee assignments based on the attributes specified.
      Finder Variables
      • BusinessUnitName; string; Business unit name for the employee assignment.
      • DepartmentName; string; Department name for the employee assignment.
      • GradeName; string; Grade name for the employee assignment.
      • JobName; string; Job name for the employee assignment.
      • LocationName; string; Location name for the employee assignment.
      • ManagerFullName; string; Full name of the manager for the employee assignment.
    • findByPersonId Finds all employee assignments for the person identifier specified.
      Finder Variables
      • PersonId; integer; Person identifier for which the assignments are to be retrieved.
      • SysEffectiveDate; object;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AsgResponsibilityId; integer; Primary key autogenerated by the application.
    • AssignmentId; integer; Internal identifier for the assignment.
    • PersonId; integer; Internal unique identifier for the person.
    • ResponsibilityName; string; Name of an area of responsibility.
    • ResponsibilityTypeCode; string; Identifier of the responsibility type for which this record holds the criteria. The value is validated against HCM_LOOKUPS with the lookup type PER_RESPONSIBILITY_TYPES.
    • ResponsibilityTypeName; string; Name of the responsibility type for which this record holds the criteria. For example, Benefits Representative.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreationDate; string; Date and time of creation of the employee role record.
    • EndDate; string; End date of the role.
    • LastUpdateDate; string; Date and time of update of the employee role record.
    • RoleCommonName; string; Short name of the role.
    • RoleGUID; string; Globally unique identifier for the role record in Oracle Cloud. Valid values are defined in the list RoleGUIDLOV.
    • RoleName; string; Name of the role.
    • StartDate; string; Start date of the role.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • PersonId; integer
    • __FLEX_Context; string; Context Value
    • __FLEX_Context_DisplayValue; string; Context Value


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • EnabledFlag; string
    • EndDateActive; string
    • StartDateActive; string
    • _ID_FLEX_NUM; integer
    • _PEOPLE_GROUP_ID; integer


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AddressLine1; string; First line of the primary mailing address.
    • AddressLine2; string; Second line of the primary mailing address.
    • AddressLine3; string; Third line of the primary mailing address.
    • CitizenshipId; integer; Primary key autogenerated by the application.
    • CitizenshipLegislationCode; string; Legislation code derived from the legal entity. Valid values are defined in the list CitizenshipLegislationCodeLOV.
    • CitizenshipStatus; string; Status of the person's citizenship. Valid values are defined in the list CitizenshipStatusLOV.
    • CitizenshipToDate; string; End date of citizenship.
    • City; string; Town or city in which the address is located.
    • CorrespondenceLanguage; string; Preferred language for communication. Valid values are defined in the list CorrespondenceLanguageLOV.
    • Country; string; Country in which the address is located.
    • CreationDate; string; Date and time of creation of the employee record.
    • DateOfBirth; string; Date of birth of the person.
    • DisplayName; string; Person's display name.
    • DriversLicenseExpirationDate; string; Expiration date of the driver's license.
    • DriversLicenseId; integer; System-generated primary key. Surrogate key.
    • DriversLicenseIssuingCountry; string; Country that issued the driver's license.
    • EffectiveStartDate; string; Date at the beginning of the period within which the employee is effective.
    • Ethnicity; string; Person's ethnicity for the legislation code. Valid values are defined in the list EthnicityLOV.
    • FirstName; string; Person's first name.
    • Gender; string; Person's gender. Valid values are defined in the list GenderLOV.
    • HireDate; string; Hire date of the employee.
    • HomeFaxAreaCode; string; Area code of the phone number for the home fax machine.
    • HomeFaxCountryCode; string; Country code of the phone number for the home fax machine.
    • HomeFaxExtension; string; Extension of the phone number for the home fax machine.
    • HomeFaxLegislationCode; string; Legislation code of the home fax number.
    • HomeFaxNumber; string; Phone number for the home fax machine.
    • HomePhoneAreaCode; string; Area code of the home phone number.
    • HomePhoneCountryCode; string; Country code of the home phone number.
    • HomePhoneExtension; string; Extension of the home phone number.
    • HomePhoneLegislationCode; string; Legislation code of the home phone number.
    • HomePhoneNumber; string; Home phone number.
    • Honors; string; Higher qualification appended to a person's name. For example, PhD.
    • LastName; string; Person's last name.
    • LastUpdateDate; string; Date and time of update of the employee record.
    • LicenseNumber; string; Person's driving license number.
    • MaritalStatus; string; Person's marital status. Valid values are defined in the list MaritalStatusLOV.
    • MiddleName; string; Person's middle name.
    • MilitaryVetStatus; string; Indicates whether the person is on military service. Valid values are defined in the list MilitaryVetStatusLOV.
    • NameSuffix; string; Part of the name appended to a person's last name.
    • NationalId; string; Primary key autogenerated by the application.
    • NationalIdCountry; string; Country of nationality.
    • NationalIdExpirationDate; string; Expiration date of the national identifier.
    • NationalIdPlaceOfIssue; string; Place where the national identifier was issued.
    • NationalIdType; string; Type of national identifier. Valid values are defined in the list NationalIdTypeLOV.
    • PassportExpirationDate; string; Expiration date of the passport.
    • PassportId; integer; Primary key autogenerated by the application.
    • PassportIssueDate; string; Date of issue of passport.
    • PassportIssuingCountry; string; Country that issued the passport.
    • PassportNumber; string; Person's passport number.
    • PersonId; integer; Internal unique identifier for the person.
    • PersonNumber; string; Number assigned to a person to identify the person uniquely. Doesn't depend on the person type (employee, contingent worker, and so on). Search on this attribute isn't case sensitive.
    • PostalCode; string; Postal code of the address.
    • PreferredName; string; Person's preferred first name.
    • PreviousLastName; string; Previous last name of the person, if any.
    • ProjectedTerminationDate; string; Projected termination date for the worker.
    • Region; string; Primary region in which the address is located.
    • Region2; string; Secondary region within the primary region.
    • Religion; string; Person's religion. Valid values are defined in the list ReligionLOV.
    • ReligionId; integer; Primary key autogenerated by the application.
    • Salutation; string; Person salutation such as Mr., Ms., and so on. Valid values are defined in the list SalutationLOV.
    • TerminationDate; string; Termination date of the employee.
    • UserName; string; User name for the record. This value is optional and is automatically generated if not specified. Also works with UsernameMatching attribute. Search on this attribute isn't case sensitive.
    • WorkEmail; string; Person's work email address. Search on this attribute isn't case sensitive.
    • WorkFaxAreaCode; string; Area code of the phone number for the work fax machine.
    • WorkFaxCountryCode; string; Country code of the phone number for the work fax machine.
    • WorkFaxExtension; string; Extension of the phone number for the work fax machine.
    • WorkFaxLegislationCode; string; Legislation code of the work fax number.
    • WorkFaxNumber; string; Phone number for the home fax machine.
    • WorkMobilePhoneAreaCode; string; Area code of the work mobile phone number.
    • WorkMobilePhoneCountryCode; string; Country code of the work mobile phone number.
    • WorkMobilePhoneExtension; string; Extension of the work mobile phone number.
    • WorkMobilePhoneLegislationCode; string; Legislation code of the work mobile phone number.
    • WorkMobilePhoneNumber; string; Work mobile phone number.
    • WorkPhoneAreaCode; string; Area code of the work phone number.
    • WorkPhoneCountryCode; string; Country code of the work phone number, such as 39 for Italy.
    • WorkPhoneExtension; string; Extension of the work phone number.
    • WorkPhoneLegislationCode; string; Legislation code of the work phone number.
    • WorkPhoneNumber; string; Work phone number.
    • WorkerType; string; Primary type of a worker such as employee (E), contingent worker (C), pending worker (P), or nonworker (N). This is a read-only attribute as indicated in the describe metadata.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • EffectiveStartDate; string; Date at the beginning of the period within which the employee direct report is effective.
    • FullName; string; Full name of the manager.
    • ManagerId; integer; Internal identifier for the manager.
    • PersonId; integer; Internal unique identifier for the person.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentId; integer
    • AssignmentType; string
    • EffectiveEndDate; string
    • EffectiveLatestChange; string
    • EffectiveSequence; integer
    • EffectiveStartDate; string
    • __FLEX_Context; string; Context Value
    • __FLEX_Context_DisplayValue; string; Context Value


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionCode; string; Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.
    • ActionReasonCode; string; User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.
    • ActualTerminationDate; string; Actual date of termination of employment. This is required during termination, when the TerminateWorkRelationshipFlag is set to Y.
    • AssignmentCategory; string; User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.
    • AssignmentId; integer; Unique identifier for the assignment. This is a primary key generated by the application.
    • AssignmentName; string; Name of the assignment.
    • AssignmentNumber; string; Unique identifier for the assignment or terms. Valid for workers and nonworkers.
    • AssignmentProjectedEndDate; string; Date on which the assignment is expected to end.
    • AssignmentStatus; string; HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.
    • AssignmentStatusTypeId; integer; Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.
    • BusinessUnitId; integer; Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.
    • CreationDate; string; Date and time of creation of the employee assignment record.
    • DepartmentId; integer; Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.
    • EffectiveEndDate; string; Date at the end of the period within which the employee assignment is effective.
    • EffectiveStartDate; string; Date at the beginning of the period within which the employee assignment is effective.
    • EndTime; string; Workday normal end time.
    • Frequency; string; Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.
    • FullPartTime; string; Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.
    • GradeId; integer; Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.
    • GradeLadderId; integer; Unique identifier for the grade ladder.
    • JobId; integer; Unique identifier for the job. Valid values are defined in the list JobIdLOV.
    • LastUpdateDate; string; Date and time of update of the employee assignment record.
    • LegalEntityId; integer; Unique identifier for the legal entity.
    • LocationId; integer; Unique identifier for the location. Valid values are defined in the list LocationIdLOV.
    • ManagerAssignmentId; integer; Identifier for the manager's assignment.
    • ManagerId; integer; Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.
    • ManagerType; string; Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.
    • OriginalHireDate; string; Original date of hire for employment.
    • PeopleGroup; string; People group represented as a concatenated value of all the related key flexfield segments.
    • PeriodOfServiceId; integer; Primary key autogenerated by the application.
    • PersonTypeId; integer; Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.
    • PositionId; integer; Unique identifier for a position. Valid values are defined in the list PositionIdLOV.
    • PrimaryAssignmentFlag; boolean; Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.
    • PrimaryWorkRelationFlag; boolean; Indicates whether the current work relationship is primary. Valid values are Yes and No.
    • PrimaryWorkTermsFlag; boolean; Indicates whether the current employment terms are primary. Valid values are Yes and No.
    • ProbationPeriodEndDate; string; End date of the probation period.
    • ProbationPeriodLength; number; Duration of the probation period.
    • ProbationPeriodUnitOfMeasure; string; Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.
    • ProjectedStartDate; string; Proposed start date for the pending worker.
    • ProposedPersonTypeId; string; Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.
    • RegularTemporary; string; Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.
    • SalaryAmount; number; Salary amount entered based on the salary frequency.
    • SalaryBasisId; integer; Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.
    • SalaryCode; string; Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.
    • StartTime; string; Workday normal start time.
    • TermsEffectiveStartDate; string; Date at the beginning of the period within which the employee term is effective.
    • WorkTaxAddressId; integer; Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.
    • WorkerCategory; string; Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.
    • WorkingAsManager; string; Indicates whether the person is a manager. Valid values are Yes and No.
    • WorkingAtHome; string; Indicates whether the person is working at home. Valid values are Yes and No.
    • WorkingHours; number; Normal working hours.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreationDate; string; Date and time of creation of the employee visa record.
    • LastUpdateDate; string; Date and time of update of the employee visa record.
    • VisaPermitCountry; string; Country for which visa or permit is valid. Valid values are defined in the list IssuingCountryLOV.
    • VisaPermitExpiration; string; Expiration date of visa or permit.
    • VisaPermitId; integer; Primary key autogenerated by the application.
    • VisaPermitNumber; string; Visa or permit number.
    • VisaPermitType; string; Visa or permit type. Valid values are defined in the list VisaPermitTypeLOV.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Image; string; Unique location of the image. Encrypted version of the file.
    • ImageId; integer; Primary key autogenerated by the application.
    • ImageName; string; Name of the image.
    • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • PersonId; integer; Person associated with the image. Foreign key to PER_ALL_PEOPLE_F.
    • PrimaryFlag; boolean; Indicates whether the image is primary.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : emps
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : emps-item-response
Type: object
Show Source
Nested Schema : Assignments
Type: array
Title: Assignments
The assignments resource is a child of the emps resource. It includes all employee assignments as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Direct Reports
Type: array
Title: Direct Reports
The directReports resource is a child of the emps resource. It includes all employee direct reports as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : personDFF
Type: array
Show Source
Nested Schema : personExtraInformation
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_EIT":"#/components/schemas/oracle_apps_hcm_people_core_flex_personEITEFF_base_view_j__PersonExtraInformationPerEitprivateVO-item-response" } }
Nested Schema : Photos
Type: array
Title: Photos
The photo resource is a child of the emps resource. It includes all employee primary photos as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Roles
Type: array
Title: Roles
The roles resource is a child of the emps resource. It includes all employee roles as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Visas
Type: array
Title: Visas
The visas resource is a child of the emps resource. It includes all employee visas as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : emps-assignments-item-response
Type: object
Show Source
Nested Schema : assignmentDFF
Type: array
Show Source
Nested Schema : assignmentExtraInformation
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response" } }
Nested Schema : Employee Representatives
Type: array
Title: Employee Representatives
The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : peopleGroupKeyFlexfield
Type: array
Show Source
Nested Schema : emps-assignments-assignmentDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response
Type: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-assignmentExtraInformation-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type: object
Show Source
Nested Schema : emps-assignments-empreps-item-response
Type: object
Show Source
Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item-response
Type: object
Show Source
Nested Schema : emps-directReports-item-response
Type: object
Show Source
Nested Schema : emps-personDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personEITEFF_base_view_j__PersonExtraInformationPerEitprivateVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO
Type: array
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : emps-photo-item-response
Type: object
Show Source
Nested Schema : emps-roles-item-response
Type: object
Show Source
Nested Schema : emps-visas-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all employees by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items": [25]
  0: {
     "Salutation" : "MS.",
     "FirstName" : "Miranda",
     "MiddleName" : "Kyle",
     "LastName" : "Rachell",
     "PreviousLastName" : null,
     "NameSuffix" : "Jr.",
     "DisplayName" : "Miranda Rachell",
     "PreferredName" : null,
     "Honors" : null,
     "CorrespondenceLanguage" : null,
     "PersonNumber" : "955160008184100",
     "WorkPhoneCountryCode" : "1",
     "WorkPhoneAreaCode" : "1",
     "WorkPhoneNumber" : "781-993-0000",
     "WorkPhoneExtension" : null,
     "WorkFaxCountryCode" : null,
     "WorkFaxAreaCode" : null,
     "WorkFaxNumber" : null,
     "WorkFaxExtension" : null,
     "WorkMobilePhoneCountryCode" : "1",
     "WorkMobilePhoneAreaCode" : "1",
     "WorkMobilePhoneNumber" : "581-993-0000",
     "WorkMobilePhoneExtension" : null,
     "HomePhoneCountryCode" : "1",
     "HomePhoneAreaCode" : "1",
     "HomePhoneNumber" : "122993333",
     "HomePhoneExtension" : null,
     "HomeFaxCountryCode" : "1",
     "HomeFaxAreaCode" : "1",
     "HomeFaxNumber" : "1111663",
     "HomeFaxExtension" : null,
     "WorkEmail" : "miranda.kyle@oracle.com",
     "AddressLine1" : "Oracle Corporation,
     "AddressLine2" : "500 Oracle Parkway",
     "AddressLine3" : null,
     "City" : "San Francisco",
     "Region" : "California",
     "Region2" : null,
     "Country" : "US",
     "PostalCode" : "94065",
     "DateOfBirth" : "1990-09-09",
     "Ethnicity" : "8",
     "LegalEntityId" : 300100003448002,
     "HireDate" : "2016-04-13",
     "TerminationDate" : null,
     "Gender" : "F",
     "MaritalStatus" : "S",
     "NationalIdType" : "SSN",
     "NationalId" : "554-44-3025",
     "NationalIdCountry" : "US",
     "NationalIdExpirationDate" : "4712-12-31",
     "PersonId" : 300100083933129,
     "EffectiveStartDate" : "2016-04-13",
     "UserName" : "rachell",
     "CitizenshipId" : 300100083933141,
     "CitizenshipStatus" : "A",
     "CitizenshipLegislationCode" : "US",
     "CitizenshipToDate" : null,
     "Religion" : "CHRISTIAN",
     "ReligionId" : 300100083933142,
     "PassportIssueDate" : "2002-12-31",
     "PassportNumber" : "11557799",
     "PassportId" : 300100083933144,
     "PassportExpirationDate" : null,
     "LicenseNumber" : "9955500858",
     "DriversLicenseId" : 300100083933143,
     "MilitaryVetStatus" : null,
     "CreationDate" : "2016-04-13T21:44:24-07:00",
     "LastUpdateDate" : "2016-04-13T21:44:25-07:00",
     "assignments" : [ {
       "AssignmentName" : "Rachell_Assignment_1",
       "PersonTypeId" : 13,
       "ProposedPersonTypeId" : null,
       "ProjectedStartDate" : null,
       "BusinessUnitId" : 202,
       "LocationId" : null,
       "JobId" : 18,
       "GradeId" : null,
       "DepartmentId" : null,
       "WorkerCategory" : "WC",
       "AssignmentCategory" : "FR",
       "WorkingAtHome" : "N",
       "WorkingAsManager" : "N",
       "SalaryCode" : "H",
       "WorkingHours" : 12,
       "Frequency" : "D",
       "StartTime" : null,
       "EndTime" : null,
       "SalaryAmount" : 100000,
       "SalaryBasisId" : 100010024999994,
       "ActionCode" : "HIRE",
       "ActionReasonCode" : "NEWHIRE",
       "AssignmentStatus" : "ACTIVE",
       "WorkTaxAddressId" : 300100011952957,
       "AssignmentId" : 300100083933157,
       "EffectiveStartDate" : "2016-04-13",
       "EffectiveEndDate" : "4712-12-31",
       "PositionId" : null,
       "TermsEffectiveStartDate" : "2016-04-13",
       "ManagerAssignmentId" : 389,
       "ManagerId" : 383,
       "ManagerType" : "LINE_MANAGER",
       "AssignmentNumber" : "E955160008184100",
       "PeriodOfServiceId" : 300100083933149,
       "OriginalHireDate" : null,
       "PrimaryAssignmentFlag" : true,
       "ProbationPeriodEndDate" : null,
       "ProbationPeriodLength" : null,
       "ProbationPeriodUnitOfMeasure" : null,
       "AssignmentProjectedEndDate" : null,
       "ActualTerminationDate" : null,
       "LegalEntityId" : 300100003448002,
       "PrimaryWorkRelationFlag" : true,
       "PrimaryWorkTermsFlag" : false,
       "CreationDate" : "2016-04-13T21:44:25-07:00",
       "LastUpdateDate" : "2016-04-13T21:44:26-07:00",
         "links":[18]
            0:  {...
               ...}
     }
  1: {
     "Salutation" : "MR.",
     "FirstName" : "Jocob",
     "MiddleName" : "Samual",
     "LastName" : "George",
     "PreviousLastName" : null,
     "NameSuffix" : "Sr.",
     "DisplayName" : "Jocob George",
     "PreferredName" : null,
     "Honors" : null,
     "CorrespondenceLanguage" : null,
     "PersonNumber" : "955160008184099",
     "WorkPhoneCountryCode" : "1",
     "WorkPhoneAreaCode" : "1",
     "WorkPhoneNumber" : "781-993-0000",
     "WorkPhoneExtension" : null,
     "WorkFaxCountryCode" : null,
     "WorkFaxAreaCode" : null,
     "WorkFaxNumber" : null,
     "WorkFaxExtension" : null,
     "WorkMobilePhoneCountryCode" : "1",
     "WorkMobilePhoneAreaCode" : "1",
     "WorkMobilePhoneNumber" : "581-993-0000",
     "WorkMobilePhoneExtension" : null,
     "HomePhoneCountryCode" : "1",
     "HomePhoneAreaCode" : "1",
     "HomePhoneNumber" : "122993333",
     "HomePhoneExtension" : null,
     "HomeFaxCountryCode" : "1",
     "HomeFaxAreaCode" : "1",
     "HomeFaxNumber" : "1111663",
     "HomeFaxExtension" : null,
     "WorkEmail" : "samual.george@oracle.com",
     "AddressLine1" : "8 VDG",
     "AddressLine2" : null,
     "AddressLine3" : null,
     "City" : "Terminal Annex",
     "Region" : "Denver",
     "Region2" : "Colorado",
     "Country" : "US",
     "PostalCode" : "80248",
     "DateOfBirth" : "1990-09-09",
     "Ethnicity" : "1",
     "LegalEntityId" : 40010,
     "HireDate" : "2016-04-13",
     "TerminationDate" : null,
     "Gender" : "M",
     "MaritalStatus" : "M",
     "NationalIdType" : "SSN",
     "NationalId" : "554-44-3021",
     "NationalIdCountry" : "US",
     "NationalIdExpirationDate" : "4712-12-31",
     "PersonId" : 300100083931662,
     "EffectiveStartDate" : "2016-04-13",
     "UserName" : "samual",
     "CitizenshipId" : 300100083931674,
     "CitizenshipStatus" : "A",
     "CitizenshipLegislationCode" : "US",
     "CitizenshipToDate" : null,
     "Religion" : "CHRISTIAN",
     "ReligionId" : 300100083931675,
     "PassportIssueDate" : "2002-12-31",
     "PassportNumber" : "11557799",
     "PassportId" : 300100083931677,
     "PassportExpirationDate" : null,
     "LicenseNumber" : "9955500858",
     "DriversLicenseId" : 300100083931676,
     "MilitaryVetStatus" : null,
     "CreationDate" : "2016-04-13T21:42:07-07:00",
     "LastUpdateDate" : "2016-04-13T21:42:09-07:00",
     "assignments" : [ {
      "AssignmentName" : "Jocob_Assignment_1",
      "PersonTypeId" : 13,
      "ProposedPersonTypeId" : null,
      "ProjectedStartDate" : null,
      "BusinessUnitId" : 202,
      "LocationId" : null,
      "JobId" : 11,
      "GradeId" : null,
      "DepartmentId" : null,
      "WorkerCategory" : "WC",
      "AssignmentCategory" : "FR",
      "WorkingAtHome" : "N",
      "WorkingAsManager" : "N",
      "SalaryCode" : "H",
      "WorkingHours" : 12,
      "Frequency" : "D",
      "StartTime" : null,
      "EndTime" : null,
      "SalaryAmount" : 100000,
      "SalaryBasisId" : 100010024999994,
      "ActionCode" : "HIRE",
      "ActionReasonCode" : "NEWHIRE",
      "AssignmentStatus" : "ACTIVE",
      "WorkTaxAddressId" : 300100011952957,
      "AssignmentId" : 300100083931690,
      "EffectiveStartDate" : "2016-04-13",
      "EffectiveEndDate" : "4712-12-31",
      "PositionId" : null,
      "TermsEffectiveStartDate" : "2016-04-13",
      "ManagerAssignmentId" : 389,
      "ManagerId" : 383,
      "ManagerType" : "LINE_MANAGER",
      "AssignmentNumber" : "E955160008184099",
      "PeriodOfServiceId" : 300100083931682,
      "OriginalHireDate" : null,
      "PrimaryAssignmentFlag" : true,
      "ProbationPeriodEndDate" : null,
      "ProbationPeriodLength" : null,
      "ProbationPeriodUnitOfMeasure" : null,
      "AssignmentProjectedEndDate" : null,
      "ActualTerminationDate" : null,
      "LegalEntityId" : 40010,
      "PrimaryWorkRelationFlag" : true,
      "PrimaryWorkTermsFlag" : false,
      "CreationDate" : "2016-04-13T21:42:08-07:00",
      "LastUpdateDate" : "2016-04-13T21:42:10-07:00",
         "links" : [8]
            0:  {...
               ...}
      ...}
}
Back to Top