Get an employee
get
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}
Request
Path Parameters
-
empsUniqID(required): string
This is the hash key of the attributes which make up the composite key 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 in order to navigate to a specific instance of Employees to get the hash key.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
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. -
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : emps-item-response
Type:
Show Source
object
-
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the primary mailing address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the primary mailing address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the primary mailing address. -
assignments: array
Assignments
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. -
CitizenshipId: integer
(int64)
Title:
Citizenship ID
Primary key autogenerated by the application. -
CitizenshipLegislationCode: string
Title:
Citizenship
Maximum Length:30
Legislation code derived from the legal entity. Valid values are defined in the list CitizenshipLegislationCodeLOV. -
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
Status of the person's citizenship. Valid values are defined in the list CitizenshipStatusLOV. -
CitizenshipToDate: string
(date)
Title:
To Date
End date of citizenship. -
City: string
Title:
Town or City
Maximum Length:60
Town or city in which the address is located. -
CorrespondenceLanguage: string
Title:
Correspondence Language
Maximum Length:30
Preferred language for communication. Valid values are defined in the list CorrespondenceLanguageLOV. -
Country: string
Title:
Country
Maximum Length:60
Country in which the address is located. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time of creation of the employee record. -
DateOfBirth: string
(date)
Title:
Date of Birth
Date of birth of the person. -
directReports: array
Direct Reports
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. -
DisplayName: string
Title:
Name
Maximum Length:240
Person's display name. -
DriversLicenseExpirationDate: string
(date)
Title:
To Date
Expiration date of the driver's license. -
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
System-generated primary key. Surrogate key. -
DriversLicenseIssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country that issued the driver's license. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the employee is effective. -
Ethnicity: string
Title:
Ethnicity
Maximum Length:30
Person's ethnicity for the legislation code. Valid values are defined in the list EthnicityLOV. -
FirstName: string
Title:
First Name
Maximum Length:150
Person's first name. -
Gender: string
Title:
Gender
Maximum Length:30
Person's gender. Valid values are defined in the list GenderLOV. -
HireDate: string
(date)
Hire date of the employee.
-
HomeFaxAreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the phone number for the home fax machine. -
HomeFaxCountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the phone number for the home fax machine. -
HomeFaxExtension: string
Title:
Extension
Maximum Length:60
Extension of the phone number for the home fax machine. -
HomeFaxLegislationCode: string
Title:
Country Code
Maximum Length:4
Legislation code of the home fax number. -
HomeFaxNumber: string
Title:
Number
Maximum Length:60
Phone number for the home fax machine. -
HomePhoneAreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the home phone number. -
HomePhoneCountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the home phone number. -
HomePhoneExtension: string
Title:
Extension
Maximum Length:60
Extension of the home phone number. -
HomePhoneLegislationCode: string
Title:
Country Code
Maximum Length:4
Legislation code of the home phone number. -
HomePhoneNumber: string
Title:
Number
Maximum Length:60
Home phone number. -
Honors: string
Title:
Honors
Maximum Length:80
Higher qualification appended to a person's name. For example, PhD. -
LastName: string
Title:
Last Name
Maximum Length:150
Person's last name. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of update of the employee record. -
LegalEntityId: integer
Unique identifier for the legal entity. Valid values are defined in the list LegalEmployerLOV.
-
LicenseNumber: string
Title:
License Number
Maximum Length:150
Person's driving license number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
Person's marital status. Valid values are defined in the list MaritalStatusLOV. -
MiddleName: string
Title:
Middle Names
Maximum Length:80
Person's middle name. -
MilitaryVetStatus: string
Maximum Length:
30
Default Value:N
Indicates whether the person is on military service. Valid values are defined in the list MilitaryVetStatusLOV. -
NameSuffix: string
Title:
Suffix
Maximum Length:80
Part of the name appended to a person's last name. -
NationalId: string
Title:
National ID
Maximum Length:30
Primary key autogenerated by the application. -
NationalIdCountry: string
Title:
Country
Maximum Length:30
Country of nationality. -
NationalIdExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the national identifier. -
NationalIdPlaceOfIssue: string
Title:
Place of Issue
Maximum Length:30
Place where the national identifier was issued. -
NationalIdType: string
Title:
National ID Type
Maximum Length:30
Type of national identifier. Valid values are defined in the list NationalIdTypeLOV. -
PassportExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the passport. -
PassportId: integer
(int64)
Title:
Passport ID
Primary key autogenerated by the application. -
PassportIssueDate: string
(date)
Title:
Issue Date
Date of issue of passport. -
PassportIssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country that issued the passport. -
PassportNumber: string
Title:
Number
Maximum Length:30
Person's passport number. -
personDFF: array
personDFF
-
personExtraInformation: array
personExtraInformation
-
PersonId: integer
(int64)
Title:
Person ID
Internal unique identifier for the person. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
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. -
photo: array
Photos
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. -
PostalCode: string
Title:
Postal Code
Maximum Length:30
Postal code of the address. -
PreferredName: string
Title:
Known As
Maximum Length:80
Person's preferred first name. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
Previous last name of the person, if any. -
ProjectedTerminationDate: string
(date)
Projected termination date for the worker.
-
Region: string
Title:
Region 1
Maximum Length:120
Primary region in which the address is located. -
Region2: string
Title:
Region 2
Maximum Length:120
Secondary region within the primary region. -
Religion: string
Title:
Religion
Maximum Length:30
Person's religion. Valid values are defined in the list ReligionLOV. -
ReligionId: integer
(int64)
Title:
Religion ID
Primary key autogenerated by the application. -
roles: array
Roles
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. -
Salutation: string
Title:
Title
Maximum Length:30
Person salutation such as Mr., Ms., and so on. Valid values are defined in the list SalutationLOV. -
TerminationDate: string
(date)
Read Only:
true
Termination date of the employee. -
UserName: string
Maximum Length:
100
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. -
visas: array
Visas
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. -
WorkEmail: string
Title:
Email
Maximum Length:240
Person's work email address. Search on this attribute isn't case sensitive. -
WorkerType: string
Read Only:
true
Maximum Length:30
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. -
WorkFaxAreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the phone number for the work fax machine. -
WorkFaxCountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the phone number for the work fax machine. -
WorkFaxExtension: string
Title:
Extension
Maximum Length:60
Extension of the phone number for the work fax machine. -
WorkFaxLegislationCode: string
Title:
Country Code
Maximum Length:4
Legislation code of the work fax number. -
WorkFaxNumber: string
Title:
Number
Maximum Length:60
Phone number for the home fax machine. -
WorkMobilePhoneAreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the work mobile phone number. -
WorkMobilePhoneCountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the work mobile phone number. -
WorkMobilePhoneExtension: string
Title:
Extension
Maximum Length:60
Extension of the work mobile phone number. -
WorkMobilePhoneLegislationCode: string
Title:
Country Code
Maximum Length:4
Legislation code of the work mobile phone number. -
WorkMobilePhoneNumber: string
Title:
Number
Maximum Length:60
Work mobile phone number. -
WorkPhoneAreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the work phone number. -
WorkPhoneCountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the work phone number, such as 39 for Italy. -
WorkPhoneExtension: string
Title:
Extension
Maximum Length:60
Extension of the work phone number. -
WorkPhoneLegislationCode: string
Title:
Country Code
Maximum Length:4
Legislation code of the work phone number. -
WorkPhoneNumber: string
Title:
Number
Maximum Length:60
Work phone number.
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
This resource is currently under controlled availability.
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
This resource is currently under controlled availability.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personExtraInformation
Type:
Show Source
array
-
Array of:
object 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
This resource is currently under controlled availability.
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
This resource is currently under controlled availability.
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
This resource is currently under controlled availability.
Nested Schema : emps-assignments-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:30
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
Title:
Reason Code
Maximum Length:30
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
(date)
Read Only:
true
Actual date of termination of employment. This is required during termination, when the TerminateWorkRelationshipFlag is set to Y. -
AssignmentCategory: string
Title:
Assignment Category
Maximum Length:30
User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV. -
assignmentDFF: array
assignmentDFF
-
assignmentExtraInformation: array
assignmentExtraInformation
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier for the assignment. This is a primary key generated by the application. -
AssignmentName: string
Title:
Assignment Name
Maximum Length:80
Name of the assignment. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique identifier for the assignment or terms. Valid for workers and nonworkers. -
AssignmentProjectedEndDate: string
(date)
Title:
Projected End Date
Date on which the assignment is expected to end. -
AssignmentStatus: string
Title:
Assignment Status
Maximum Length:30
HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV. -
AssignmentStatusTypeId: integer
(int64)
Title:
Assignment Status Type ID
Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time of creation of the employee assignment record. -
DefaultExpenseAccount: string
Default expense account represented as a concatenated value of all the related segments.
-
DepartmentId: integer
(int64)
Title:
Organization ID
Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the period within which the employee assignment is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the employee assignment is effective. -
empreps: array
Employee Representatives
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. -
EndTime: string
Title:
End Time
Maximum Length:5
Workday normal end time. -
Frequency: string
Title:
Frequency
Maximum Length:30
Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
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
(int64)
Title:
Grade ID
Unique identifier for the grade. Valid values are defined in the list GradeIdLOV. -
GradeLadderId: integer
(int64)
Title:
Grade Ladder ID
Unique identifier for the grade ladder. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier for the job. Valid values are defined in the list JobIdLOV. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of update of the employee assignment record. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Unique identifier for the legal entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location ID
Unique identifier for the location. Valid values are defined in the list LocationIdLOV. -
ManagerAssignmentId: integer
(int64)
Title:
Manager Assignment ID
Identifier for the manager's assignment. -
ManagerId: integer
(int64)
Title:
Manager ID
Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV. -
ManagerType: string
Title:
Type
Maximum Length:30
Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on. -
OriginalHireDate: string
(date)
Read Only:
true
Original date of hire for employment. -
PeopleGroup: string
People group represented as a concatenated value of all the related key flexfield segments.
-
peopleGroupKeyFlexfield: array
peopleGroupKeyFlexfield
-
PeriodOfServiceId: integer
(int64)
Title:
Period of Service ID
Primary key autogenerated by the application. -
PersonTypeId: integer
(int64)
Title:
Person Type ID
Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV. -
PositionId: integer
(int64)
Title:
Position ID
Unique identifier for a position. Valid values are defined in the list PositionIdLOV. -
PrimaryAssignmentFlag: boolean
Title:
Primary Assignment
Maximum Length:30
Default Value:false
Indicates whether the current assignment is the primary assignment. Valid values are Yes and No. -
PrimaryWorkRelationFlag: boolean
Title:
Primary Work Relationship
Maximum Length:30
Indicates whether the current work relationship is primary. Valid values are Yes and No. -
PrimaryWorkTermsFlag: boolean
Title:
Primary Employment Terms
Maximum Length:30
Default Value:false
Indicates whether the current employment terms are primary. Valid values are Yes and No. -
ProbationPeriodEndDate: string
(date)
Title:
Probation End Date
End date of the probation period. -
ProbationPeriodLength: number
Title:
Probation Period
Duration of the probation period. -
ProbationPeriodUnitOfMeasure: string
Title:
Probation Unit
Maximum Length:30
Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS. -
ProjectedStartDate: string
(date)
Title:
Projected Start Date
Proposed start date for the pending worker. -
ProposedPersonTypeId: string
Title:
Proposed Person Type
Maximum Length:30
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
Title:
Regular or Temporary
Maximum Length:30
Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV. -
SalaryAmount: number
Title:
Salary Amount
Salary amount entered based on the salary frequency. -
SalaryBasisId: integer
(int64)
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
Title:
Hourly Paid or Salaried
Maximum Length:30
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
Title:
Start Time
Maximum Length:5
Workday normal start time. -
TermsEffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the employee term is effective. -
WorkerCategory: string
Title:
Worker Category
Maximum Length:30
Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV. -
WorkingAsManager: string
Title:
Working as a Manager
Maximum Length:30
Indicates whether the person is a manager. Valid values are Yes and No. -
WorkingAtHome: string
Title:
Working at Home
Maximum Length:30
Indicates whether the person is working at home. Valid values are Yes and No. -
WorkingHours: number
Title:
Working Hours
Normal working hours. -
WorkTaxAddressId: integer
(int64)
Title:
Tax Address ID
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.
Nested Schema : assignmentExtraInformation
Type:
Show Source
array
-
Array of:
object 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
This resource is currently under controlled availability.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-assignmentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AssignmentId: integer
(int64)
Title:
Assignment ID
-
AssignmentType: string
Title:
Assignment Type
Maximum Length:30
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
-
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
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:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
-
AssignmentType: string
Title:
Assignment Type
Maximum Length:30
-
CategoryCode: string
Title:
EFF Context
Maximum Length:80
Default Value:PER_ASG_EIT
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
-
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
InformationORA_5FPER_5FRET_5FGRADEprivateVO: array
InformationORA_5FPER_5FRET_5FGRADEprivateVO
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_PER_RET_GRADE
-
AssignmentExtraInfoId: integer
(int64)
-
AssignmentId: integer
(int64)
-
BusinessGroupId: integer
(int64)
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Maximum Length:
30
Default Value:Y
-
EffectiveSequence: integer
(int32)
Default Value:
1
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
endDate: string
(date)
Title:
End Date
-
frequency: string
Title:
Pay Basis
Maximum Length:150
-
grade: string
Title:
Grade
Maximum Length:150
-
grade_Display: string
Title:
Grade
-
gradeLadder: string
Title:
Pay Table ID
Maximum Length:150
-
gradeLadder_Display: string
Title:
Pay Table ID
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
payPlan: string
Title:
Pay Plan
Maximum Length:150
-
primaryIndicator: string
Title:
Primary Indicator
Maximum Length:150
-
primaryIndicator_Display: string
Title:
Primary Indicator
-
startDate: string
(date)
Title:
Start Date
-
step: string
Title:
Step
Maximum Length:150
-
step_Display: string
Title:
Step
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-empreps-item-response
Type:
Show Source
object
-
AsgResponsibilityId: integer
(int64)
Read Only:
true
Primary key autogenerated by the application. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Internal unique identifier for the person. -
ResponsibilityName: string
Read Only:
true
Maximum Length:240
Name of an area of responsibility. -
ResponsibilityTypeCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
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
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the responsibility type for which this record holds the criteria. For example, Benefits Representative.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item-response
Type:
Show Source
object
-
_ID_FLEX_NUM: integer
(int64)
Read Only:
true
-
_PEOPLE_GROUP_ID: integer
(int64)
Read Only:
true
-
EnabledFlag: string
Read Only:
true
Maximum Length:1
-
EndDateActive: string
(date)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDateActive: string
(date)
Read Only:
true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-directReports-item-response
Type:
Show Source
object
-
EffectiveStartDate: string
(date)
Read Only:
true
Date at the beginning of the period within which the employee direct report is effective. -
FullName: string
Read Only:
true
Maximum Length:2000
Full name of the manager. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerId: integer
(int64)
Read Only:
true
Internal identifier for the manager. -
PersonId: integer
Read Only:
true
Internal unique identifier for the person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-personDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CategoryCode: string
Maximum Length:
80
Default Value:PER_EIT
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO: array
PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO
-
PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO: array
PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO
-
PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO: array
PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO
-
PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO: array
PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO
-
PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO: array
PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO
-
PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO: array
PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO
-
PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO: array
PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO
-
PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO: array
PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO
-
PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO: array
PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO
-
PersonId: integer
(int64)
Title:
Person ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO
Type:
Show Source
array
Nested Schema : PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO
Type:
Show Source
array
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO-item-response
Type:
Show Source
object
-
_APPROVE_DATE_LEAVE: string
(date)
Title:
Demobilization Approval Date
-
_APPROVE_UNIT_LEAVE: string
Title:
Demobilization Approval Authority
Maximum Length:150
-
_JOIN_DATE: string
(date)
Title:
Enlistment Date
-
_JOIN_PLACE: string
Title:
Enlistment Location
Maximum Length:150
-
_LAST_LEVEL: string
Title:
Military Level Prior to Demobilization
Maximum Length:150
-
_LAST_LEVEL_Display: string
Title:
Military Level Prior to Demobilization
-
_LAST_POSITION: string
Title:
Job Prior to Demobilization
Maximum Length:150
-
_LAST_PROF_TITLE_LEVEL: string
Title:
Professional Technical Level Prior to Demobilization
Maximum Length:150
-
_LAST_RANK: string
Title:
Rank Prior to Demobilization
Maximum Length:150
-
_LAST_RANK_Display: string
Title:
Rank Prior to Demobilization
-
_LAST_SALARY_GRADE: string
Title:
Salary Grade Prior to Demobilization
Maximum Length:150
-
_RESERVE_OFFICIAL_RESIGNATION: string
Title:
Registered for Reserve
Maximum Length:150
-
_RESERVE_OFFICIAL_RESIGNATION_Display: string
Title:
Registered for Reserve
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_CN_MILITARY_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO-item-response
Type:
Show Source
object
-
_WORK_LIFE_START_DATE: string
(date)
Title:
Working Life Start Date
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_CN_OTHER_EMPLOYEE_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO-item-response
Type:
Show Source
object
-
_ARCHIVE_FORMAT: string
Title:
Archived Format
Maximum Length:150
-
_ARCHIVE_FORMAT_Display: string
Title:
Archived Format
-
_DUPLICATE_COPY_LOCATION: string
Title:
Secondary Copy Storage Location
Maximum Length:150
-
_FILE_NUMBER: string
Title:
File Number
Maximum Length:150
-
_ORIGINAL_COPY_LOCATION: string
Title:
Original Copy Storage Location
Maximum Length:150
-
_SOURCE_UNIT: string
Title:
Transfer From Organization
Maximum Length:150
-
_TARGET_UNIT: string
Title:
Transfer To Organization
Maximum Length:150
-
_TRANSFER_IN_DATE: string
(date)
Title:
Transfer In Date
-
_TRANSFER_OUT_DATE: string
(date)
Title:
Transfer Out Date
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_CN_PERSONAL_FILE_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO-item-response
Type:
Show Source
object
-
_IDENTITY: string
Title:
Personal Identity
Maximum Length:150
-
_IDENTITY_Display: string
Title:
Personal Identity
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_CN_PERSONALITY_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO-item-response
Type:
Show Source
object
-
_EXCEPTION_DATE: string
(date)
Title:
Membership Exception Date
-
_EXCEPTION_REASON: string
Title:
Membership Exception Reason
Maximum Length:150
-
_EXCEPTION_TYPE: string
Title:
Membership Exception Type
Maximum Length:150
-
_EXCEPTION_TYPE_Display: string
Title:
Membership Exception Type
-
_INTRODUCER1: string
Title:
Party Member Proposer 1
Maximum Length:150
-
_INTRODUCER2: string
Title:
Party Member Proposer 2
Maximum Length:150
-
_JOIN_DATE: string
(date)
Title:
Membership Acquired Date
-
_JOIN_PLACE: string
Title:
Membership Acquired Location
Maximum Length:150
-
_JOIN_UNIT: string
Title:
Membership Acquired Organization
Maximum Length:150
-
_MEMBER_FROM_DATE: string
(date)
Title:
Formal Membership Start Date
-
_PARTY_TYPE: string
Title:
Political Status
Maximum Length:150
-
_PARTY_TYPE_Display: string
Title:
Political Status
-
_STATUS: string
Title:
Membership Status
Maximum Length:150
-
_STATUS_Display: string
Title:
Membership Status
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_CN_POLITICAL_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO-item-response
Type:
Show Source
object
-
_CASTE: string
Title:
Caste or Tribe
Maximum Length:150
-
_COMMUNITY: string
Title:
Community
Maximum Length:150
-
_COMMUNITY_DisplayValue: string
Title:
Community
-
_EX_SERVICE_PERSON: string
Title:
Ex-Service Person
Maximum Length:150
-
_HEIGHT: string
Title:
Height
Maximum Length:150
-
_PAN_APPLIED: string
Title:
PAN Applied
Maximum Length:150
-
_PAN_REFERENCE_NUMBER: string
Title:
PAN Acknowledgment Number
Maximum Length:150
-
_RESIDENTIAL_STATUS: string
Title:
Residential Status
Maximum Length:150
-
_RESIDENTIAL_STATUS_Display: string
Title:
Residential Status
-
_WEIGHT: integer
(int32)
Title:
Weight
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
isDirector: string
Title:
Director
Maximum Length:150
-
isDirector_Display: string
Title:
Director
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_IN_MISCELLANEOUS
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
-
referenceNumber: string
Title:
Reference Number
Maximum Length:150
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO-item-response
Type:
Show Source
object
-
_BENEFIT_TYPE: string
Title:
Benefit Type
Maximum Length:150
-
_BENEFIT_TYPE_Display: string
Title:
Benefit Type
-
_CONTACT_PERSON: string
Title:
Contact Person
Maximum Length:150
-
_CONTACT_PERSON_Display: string
Title:
Contact Person
-
_NOMINATION_END_REASON: string
Title:
Nomination End Reason
Maximum Length:150
-
_PERCENT_SHARE: integer
(int32)
Title:
Share Percentage
-
_SEQUENCE_NUMBER: integer
(int32)
Title:
Sequence Number
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:HRX_IN_NOMINATION
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxCaDgAboriginal: string
Title:
Aboriginal
Maximum Length:150
-
oraHrxCaDgDisabled: string
Title:
Disabled
Maximum Length:150
-
oraHrxCaDgNodesgrp: string
Title:
No designated group provided
Maximum Length:150
-
oraHrxCaDgVisibleMinority: string
Title:
Visible Minority
Maximum Length:150
-
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_CA_DESIGNATED_GROUPS
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
FrdateOfEvent: string
(date)
Title:
Date of Event
-
FrDiscComment: string
Title:
Comment
Maximum Length:150
-
FrDiscEventAction: string
Title:
Disciplinary Action
Maximum Length:150
-
FrDiscEventAction_Display: string
Title:
Disciplinary Action
-
FrEvent: string
Title:
Event
Maximum Length:150
-
FrEvent_Display: string
Title:
Event
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_FR_DISC_ACTIONS
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
examType: string
Title:
Exam Type
Maximum Length:150
-
examType_Display: string
Title:
Exam Type
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nextExamDate: string
(date)
Title:
Next Exam date
-
occupationalMedicineCenter: string
Title:
Occupational Medicine Center
Maximum Length:150
-
occupationalMedicineCenter_Display: string
Title:
Occupational Medicine Center
-
oraHrxFrExam: string
(date)
Title:
Exam Date
-
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_FR_MED_EXAM
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
delegationHours: integer
(int32)
Title:
Delegation Hours
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
endDate: string
(date)
Title:
End Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
mandateType: string
Title:
Mandate Type
Maximum Length:150
-
mandateType_Display: string
Title:
Mandate Type
-
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_FR_PERSO_REP
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
-
startDate: string
(date)
Title:
Role Start Date
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OraHrxGbPsSwcEyts: string
Title:
Early Years Teacher Status
Maximum Length:150
-
OraHrxGbPsSwcEyts_Display: string
Title:
Early Years Teacher Status
-
OraHrxGbPsSwcHlta: string
Title:
Higher Level Teaching Assistant Status
Maximum Length:150
-
OraHrxGbPsSwcHlta_Display: string
Title:
Higher Level Teaching Assistant Status
-
OraHrxGbPsSwcQtls: string
Title:
Qualified Teacher Learning and Skills Status
Maximum Length:150
-
OraHrxGbPsSwcQtls_Display: string
Title:
Qualified Teacher Learning and Skills Status
-
OraHrxGbPsSwcQts: string
Title:
Qualified Teacher Status
Maximum Length:150
-
OraHrxGbPsSwcQts_Display: string
Title:
Qualified Teacher Status
-
OraHrxGbPsSwcQualQtsRoute: string
Title:
QTS Route
Maximum Length:150
-
OraHrxGbPsSwcQualQtsRoute_Display: string
Title:
QTS Route
-
OraHrxGbPsSwcSlt: string
Title:
Senior Leadership Team
Maximum Length:150
-
OraHrxGbPsSwcSlt_Display: string
Title:
Senior Leadership Team
-
OraHrxGbSwcNqt: string
Title:
Newly Qualified Teacher
Maximum Length:150
-
OraHrxGbSwcNqt_Display: string
Title:
Newly Qualified Teacher
-
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_GB_SWC_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OraHrxGbPsSwcClassOfDeg: string
Title:
Class of Degree
Maximum Length:150
-
OraHrxGbPsSwcClassOfDeg_Display: string
Title:
Class of Degree
-
OraHrxGbPsSwcQualCode: string
Title:
Qualification Code
Maximum Length:150
-
OraHrxGbPsSwcQualCode_Display: string
Title:
Qualification Code
-
OraHrxGbPsSwcSubj1: string
Title:
Qualification Subject 1
Maximum Length:150
-
OraHrxGbPsSwcSubj1_Display: string
Title:
Qualification Subject 1
-
OraHrxGbPsSwcSubj2: string
Title:
Qualification Subject 2
Maximum Length:150
-
OraHrxGbPsSwcSubj2_Display: string
Title:
Qualification Subject 2
-
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_GB_SWC_QUAL_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
ItDiscEvent: string
Title:
Event
Maximum Length:150
-
ItDiscEvent_Display: string
Title:
Event
-
ItDiscEventAction: string
Title:
Disciplinary Action
Maximum Length:150
-
ItDiscEventAction_Display: string
Title:
Disciplinary Action
-
ItDiscEventDate: string
(date)
Title:
Date of Event
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_IT_DISC_ACTIONS
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
ItOrgRole: string
Title:
Role
Maximum Length:150
-
ItOrgRole_Display: string
Title:
Role
-
ItOrgRoleStartDate: string
(date)
Title:
Role Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_IT_ORG_ROLE
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
ItEnrolEndDate: string
(date)
Title:
Enrollment End Date
-
ItEnrolStartDate: string
(date)
Title:
Enrollment Start Date
-
ItTradeUnionName: number
Title:
Trade Union Name
-
ItTradeUnionName_Display: string
Title:
Trade Union Name
-
ItTradeUnionRel: string
Title:
Trade Union Relationship
Maximum Length:150
-
ItTradeUnionRel_Display: string
Title:
Trade Union Relationship
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_IT_TRADE_UNION_REL
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO-item-response
Type:
Show Source
object
-
bidcomment: string
Title:
Comment
Maximum Length:150
-
bidcurrency: string
Title:
Currency
Maximum Length:150
-
bidrate: number
Title:
Hourly Rate
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeiAttributeCategory: string
Maximum Length:
30
-
PeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_IRC_CONTINGENT_TALENT_INFO
-
PersonExtraInfoId: integer
(int64)
-
PersonId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-photo-item-response
Type:
Show Source
object
-
Image: string
(byte)
Title:
Image
Unique location of the image. Encrypted version of the file. -
ImageId: integer
(int64)
Title:
Photo ID
Primary key autogenerated by the application. -
ImageName: string
Title:
Photo Name
Maximum Length:240
Name of the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
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
(int64)
Person associated with the image. Foreign key to PER_ALL_PEOPLE_F.
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:false
Indicates whether the image is primary.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-roles-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Date and time of creation of the employee role record.
-
EndDate: string
(date)
End date of the role.
-
LastUpdateDate: string
(date-time)
Date and time of update of the employee role record.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCommonName: string
Maximum Length:
4000
Short name of the role. -
RoleGUID: string
Maximum Length:
64
Globally unique identifier for the role record in Oracle Cloud. Valid values are defined in the list RoleGUIDLOV. -
RoleName: string
Maximum Length:
4000
Name of the role. -
StartDate: string
(date)
Start date of the role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-visas-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time of creation of the employee visa record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of update of the employee visa record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitCountry: string
Title:
Issuing Country
Maximum Length:30
Country for which visa or permit is valid. Valid values are defined in the list IssuingCountryLOV. -
VisaPermitExpiration: string
(date)
Title:
Expiration Date
Expiration date of visa or permit. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Primary key autogenerated by the application. -
VisaPermitNumber: string
Title:
Number
Maximum Length:30
Visa or permit number. -
VisaPermitType: string
Title:
Type
Maximum Length:30
Visa or permit type. Valid values are defined in the list VisaPermitTypeLOV.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assignments
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
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. - empsUniqID:
- directReports
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
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. - empsUniqID:
- personDFF
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
- empsUniqID:
- personExtraInformation
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
- empsUniqID:
- photo
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
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. - empsUniqID:
- roles
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
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. - empsUniqID:
- visas
-
Parameters:
- empsUniqID:
$request.path.empsUniqID
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. - empsUniqID:
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: {... ...}}