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--- PersonId, EffectiveStartDate, CitizenshipId, ReligionId, PassportId and DriversLicenseId ---for the Employees resource and used to uniquely identify an instance of Employees. The client should not generate the hash key value. Instead, the client should query on the Employees collection resource with a filter on the primary key values in order to navigate to a specific instance of Employees.

    For example: emps?q=PersonId=<value1>;EffectiveStartDate=<value2>;CitizenshipId=<value3>;ReligionId=<value4>;PassportId=<value5>;DriversLicenseId=<value6>
Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : emps-item
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 : Person Descriptive Flexfields
Type: array
Title: Person Descriptive Flexfields
The personDFF resource is a child of the emps resource. It includes all employee descriptive flexfields as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Person Extra Information Extensible FlexFields
Type: array
Title: Person Extra Information Extensible FlexFields
The personExtraInformation resource is a child of the emps resource. It includes all the extensible flexfields for additional person information as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
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
Type: object
Show Source
Nested Schema : Assignment Descriptive Flexfields
Type: array
Title: Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the assignments resource, and hence a child of child of the emps resource. It includes all employee assignment key flexfields as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Assignment Extra Information Extensible FlexFields
Type: array
Title: Assignment Extra Information Extensible FlexFields
The assignmentExtraInformation resource is a child of the emps resource. It includes all the extensible flexfields for additional assignment information as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Show Source
Nested Schema : Employee Representatives
Type: array
Title: Employee Representatives
The empreps resource is a child of the assignments resource, and hence a child of child of the emps 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 : People Group Key Flexfields
Type: array
Title: People Group Key Flexfields
The peopleGroupKeyFlexfield resource is a child of the assignments resource, and hence a child of child of the emps resource. It includes all employee assignment key flexfields 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-assignmentDFF-item
Type: object
Show Source
Nested Schema : emps-assignments-assignmentExtraInformation-item
Type: object
Show Source
Nested Schema : emps-assignments-empreps-item
Type: object
Show Source
Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item
Type: object
Show Source
Nested Schema : emps-directReports-item
Type: object
Show Source
Nested Schema : emps-personDFF-item
Type: object
Show Source
Nested Schema : emps-personExtraInformation-item
Type: object
Show Source
Nested Schema : emps-photo-item
Type: object
Show Source
Nested Schema : emps-roles-item
Type: object
Show Source
Nested Schema : emps-visas-item
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