Get an employee

get

/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the (emps) resource and used to uniquely identify an instance of (emps). The client should not generate the hash key value. Instead, the client should query on the (emps) collection resource in order to navigate to a specific instance of (emps) to get the hash key.
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "CRFL_Context_Test":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDFF_view_PersonDFFCRFL__5FContext__5FTestVO-item-response" } }
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 : workers-workRelationships-assignments-assignmentsEFF-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 : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDFF_view_PersonDFFCRFL__5FContext__5FTestVO-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 : 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 : 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 : 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 an employee 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/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000013C91DF5C40780000000EACED00057708000110F07EBB27BD

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.

{
  "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" : [18]
        0:  {...
            ...}
}
Back to Top