APIs Available for HR Foundation Users (Oracle HRMS)

APIs Available for HR Foundation Users

Application Programmatic Interfaces (APIs) are a logical grouping of all external process routines. The Oracle HRMS API strategy delivers a set of PL/SQL packages procedures and functions that provide an open interface to the database. Further information on the purpose of each API is available in the API package header. For information on how to call APIs, see the technical essay APIs in Oracle HRMS. See also the Oracle Applications System Administrator's Guide. See also:
q

Publicly Callable Business Process APIs in iRecruitment Publicly Callable Business Process APIs in Oracle Learning Management Publicly Callable Business Process APIs in Oracle Time & Labor

The following table shows the APIs delivered with Oracle Foundation. Attention: This list includes all the supported APIs in Oracle HRMS, including HR, Payroll, and Standard and Advanced Benefits. Any APIs not included in this list are for internal use only and are not supported. Additional Information: Note: Legislation WW = All Legislations These APIs are supported for HR Foundation users: Supported by Data Pump Yes No No Yes Yes Yes Yes No Yes Yes

Package Name

File Name

Business Process create_competence_element delete_competence_element, update_competence_element update_personal_comp_element create_competence, update_competence create_employee re_hire_ex_employee create_hierarchy_element delete_hierarchy_element, update_hierarchy_element create_job

User Hooks Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

Legislation WW WW WW WW WW WW WW WW WW WW

hr_competence_element_api pecelapi. pkh hr_competence_element_api pecelapi. pkh hr_competence_element_api pecelapi. pkh hr_competences_api hr_employee_api hr_employee_api hr_hierarchy_element_api hr_hierarchy_element_api hr_job_api hr_location_api pecpnapi. pkh peempapi. pkh peempapi. pkh peoseapi. pkh peoseapi. pkh pejgobapi. pkh

hrlocapi.pkh create_location, update_location

file:///D|/My Documents/Working/Foundation APIs.htm (1 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

hr_location_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_organization_api hr_person_address_api hr_phone_api hr_phone_api hr_pos_hierarchy_ele_api

hrlocapi.pkh delete_location hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh hrorgapi. pkh peaddapi. pkh pephnapi. pkh pephnapi. pkh pepseapi. pkh peposapi. pkh pertlapi.pkh create_bgr_classif, create_business_group create_legal_entity, create_legal_entity_classif create_oper_unit_classif create_operating_unit create_org_classification create_org_information create_org_manager create_organization, update_organization delete_org_manager delete_organization disable_org_classification, enable_org_classification trans_org_name update_org_information update_org_manager create_person_address, update_person_address create_phone, update_phone delete_phone create_pos_hierarchy_ele, update_pos_hierarchy_ele, delete_pos_hierarchy_ele create_position, update_position, delete_position create_rating_level, delete_rating_level

No No Yes No No No No Yes No No Yes No No No No No No Yes Yes No No

Yes No No No No No No Yes Yes No Yes Yes Yes No No Yes No Yes Yes Yes Yes

WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW WW

hr_position_api hr_rating_levels_api

Yes No

Yes Yes

WW WW

file:///D|/My Documents/Working/Foundation APIs.htm (2 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

hr_rating_levels_api hr_rating_scales_api hr_rating_scales_api hr_valid_grade_api per_job_group_api per_job_group_api

pertlapi.pkh perscapi. pkh perscapi. pkh pevgrapi. pkh pejgrapi. pkh pejgrapi. pkh

update_rating_level create_rating_scale, update_rating_scale delete_rating_scale create_valid_grade create_job_group, update_job_group delete_job_group

Yes Yes No Yes Yes No

Yes Yes Yes Yes Yes Yes

WW WW WW WW WW WW

For more information about APIs, see: APIs in Oracle HRMS

APIs to Which Restrictions Apply for HR Foundation

You can perform the following tasks using the APIs listed, however you must only use the restricted list of parameters as shown in the following tables: hr_employee_api To create an employee call the following API: Business Process Special Instructions None

File Name peempapi. pkh

Package Name

Available Parameters p_validate p_hire_date p_business_group_id p_last_name p_previous_last_name p_mailstop p_office_number p_internal_location p_correspondence_language p_known_as p_sex p_date_of_birth p_email_address p_employee_number p_expense_check_send_to_address p_first_name p_middle_names p_national_identifier p_title p_work_telephone p_attribute_category p_attribute1-30

hr_employee_api create_employee

To re-hire an ex-employee call the following API: Special Instructions

File Name peempapi. pkh

Package Name

Business Process

Available Parameters p_validate p_hire_date p_person_id p_object_version_number

hr_employee_api re_hire_ex_employee None

hr_contingent_worker_api To create a contingent worker call the following API: Business Process Special Instructions

File Name

Package Name

Available Parameters

file:///D|/My Documents/Working/Foundation APIs.htm (3 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

pecwkapi. pkh

hr_contingent_worker_api create_cwk

None

p_validate p_business_group_id p_last_name p_email_address p_npw_number p_first_name p_middle_names p_previous_last_name p_mailstop p_title p_known_as p_work_telephone p_start_date p_sex p_date_of_birth p_national_identifier p_office_number p_internal_location p_correspondence_language p_attribute_category p_attribute1-30

To terminate a contingent worker's placement call the following API: File Name

Package Name

Business Process

Special Instructions

Available Parameters p_effective_date p_final_process_date p_last_standard_date p_validate p_person_id p_date_start p_object_version_number p_actual_termination_date p_projected_termination_date

pecwkapi. hr_contingent_worker_api terminate_placement p_effective_date must be set pkh to the system date. p_final_process_date and p_last_standard_process_date should be set to the same date as p_actual_termination_date

To reverse a placement termination call the following API: Special Instructions

File Name pecwkapi. pkh

Package Name

Business Process

Available Parameters p_effective_date p_validate p_person_id p_actual_termination_date p_clear_details

hr_contingent_worker_api reverse_terminate_placement p_effective_date must be set to the system date.

hr_person_api To update an employee or contingent worker's personal information call the following API: File Name peperapi. pkh Package Name hr_person_api Business Process update_person

Special Instructions p_effective_date must be set to the system date. p_datetrack_update_mode must be set to CORRECTION.

Available Parameters p_effective_date p_datetrack_update_mode p_validate p_hire_date p_business_group_id p_last_name p_sex p_date_of_birth p_email_address p_employee_number p_npw_number p_expense_check_send_to_address p_title p_first_name p_middle_names p_national_identifier p_previous_last_name p_known_as p_mailstop p_office_number p_internal_location p_correspondence_language

file:///D|/My Documents/Working/Foundation APIs.htm (4 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

p_work_telephone p_attribute_category p_attribute1-30 p_object_version_number p_party_id hr_ex_employee_api To terminate an employee call the following API: Special Instructions

File Name peexeapi. pkh

Package Name

Business Process

Available Parameters p_validate p_period_of_service_id p_object_version_number p_actual_termination_date

hr_ex_employee_api actual_termination_emp None

followed by Business Process

File Name peexeapi. pkh

Package Name

Special Instructions

Available Parameters p_final_process_date p_actual_termination_date p_validate p_period_of_service_id p_object_version_number

hr_ex_employee_api final_process_emp p_final_process_date must be the same date as was set for the p_actual_termination_date in the actual_termination_emp API.

hr_assignment_api To update an employee's assignment or a contingent worker's assignment, call one of the following APIs: File Name peasgapi. pkh

Package Name

Business Process

Special Instructions p_effective_date must be set to the system date. p_datetrack_update_mode must be set to CORRECTION. When trying to perform a correction to an employee's supervisor, the new supervisor must exist for the entire duration of the employee's assignment. If you want to assign a supervisor who does not exist for the entire duration of the assignment, then you can do this using the Enter Employee window.

Available Parameters p_effective_date p_datetrack_update_mode p_validate p_assignment_id p_supervisor_id p_object_version_number p_assignment_number p_default_code_comb_id p_set_of_books_id p_title p_ass_attribute_category p_ass_attribute1-30

hr_assignment_api update_emp_asg

file:///D|/My Documents/Working/Foundation APIs.htm (5 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

peasgapi. pkh

hr_assignment_api update_emp_asg_criteria p_effective_date must be set to the system date. p_datetrack_update_mode must be set to CORRECTION. hr_assignment_api update_cwk_asg p_effective_date must be set to the system date. p_datetrack_update_mode must be set to CORRECTION.

p_effective_date p_datetrack_update_mode p_validate p_assignment_id p_object_version_number p_position_id p_job_id p_organization_id p_location_id p_effective_date p_datetrack_update_mode p_validate p_assignment_id p_object_version_number p_assignment_number p_supervisor_id p_title p_set_of_books_id p_vendor_id p_vendor_employee_number p_manager_flag p_employment_category p_ass_attribute_category p_ass_attribute1-30 p_effective_date p_datetrack_update_mode p_validate p_assignment_id p_object_version_number p_position_id p_job_id p_organization_id p_location_id

peasgapi. pkh

peasgapi. pkh

hr_assignment_api update_cwk_asg_criteria

p_effective_date must be set to the system date. p_datetrack_update_mode must be set to CORRECTION.

hr_position_api To update a position call the following API. Note that there are two position APIs, one for full HRMS users and one for HR Foundation users. Refer to the comments in peposapi.pkh for details about these APIs. Package Name Special Instructions None

File Name peposapi. pkh

Business Process

Available Parameters You can use all of the parameters in the version of this API that is specifically for HR Foundation users.

hr_position_api create_position update_position delete_position

hr_competence_element_api To create, update and delete personal competencies call one of the following APIs: File Name Special Instructions

Package Name

Business Process

Available Parameters

file:///D|/My Documents/Working/Foundation APIs.htm (6 of 7)9/26/2005 3:21:01 AM

APIs Available for HR Foundation Users (Oracle HRMS)

pecelapi. hr_competence_element_api create_competence_element pkh

p_effective_date must be set to the system date. p_type must be set to PERSONAL.

p_effective_date p_type p_validate p_business_group p_competence_id p_proficiency_level p_rating_level p_person_id p_effective_date_from p_effective_date_to p_source_of_proficiency_level p_certification_date p_certification_method p_next_certification_date p_comments p_attribute_category p_attribute1 - 20 p_party_id

pecelapi. hr_competence_element_api update_competence_element pkh

p_effective_date p_effective_date must be set to p_competence_element_id the system date. p_object_version_number p_validate p_proficiency_level p_rating_level p_effective_date_from p_effective_date_to p_source_of_proficiency_level p_certification_date p_certification_method p_next_certification_date p_comments p_attribute_category p_attribute1 - 20 p_party_id p_effective_date p_competence_element_id p_object_version_number p_validate p_proficiency_level p_effective_date_from p_effective_date_to p_source_of_proficiency_level p_certification_date p_certification_method p_next_certification_date p_comments p_attribute_category p_attribute1 - 20

pecelapi. hr_competence_element_api update_personal_comp_element p_effective_date pkh must be set to the system date. This API automatically maintains an historical record of the old competence profile entry if the effective date and proficiency level have changed. The old competence profile entry is end dated and a new competence profile record is created. pecelapi. hr_competence_element_api delete_competence_element pkh None

p_competence_element_id p_object_version_number p_validate

file:///D|/My Documents/Working/Foundation APIs.htm (7 of 7)9/26/2005 3:21:01 AM