APIs in Release 11.

0
API code has been renamed for Release 11. The file name format has changed from
*bpi.pkh to *api.pkh. For example, the file name for the Create Employee API has
changed from peempbpi.pkh to peempapi.pkh.

Table 1 - 1 shows the APIs current in Release 11.0. The list includes forty nine new APIs
in the following areas:

o ex-employee (two)

o contact relationship (two)

o phone creation (three)

o job creation (one)

o career management (thirty eight)

o user hook calls (three)

The new APIs are shown in bold type.

Note: The update_term_details_emp api for ex-employees is available from Release 10
Prod 16.1.

See Also

Calling APIs, Oracle HRMS UK Implementation Guide, Release 11.0

DateTrack, Oracle HRMS UK Implementation Guide, Release 11.0

Information for New Users

The APIs listed in Table 1 - 1 are all publicly callable business process APIs. You can use
them all and Oracle supports them all. However, there are other business process APIs
included with some of the files below which are not supported yet.

The APIs do not maintain security tables. You should run LISTGEN separately after
using the APIs to regenerate security lists if required.

Flexfield APIs

No flexfield APIs exist yet. This means that you must consider what validation each
flexfield segment requires and write your own code to maintain flexfield information.
'Skeleton' packages (filename *****fli.pkh, *****fli.pkb) have been provided to hold
such code. They will raise an error if any flex segments containing data are passed to the
APIs.

Validation is provided for US and GB versions of legislation specific flex structures.

These include the following:

o the protected descriptive flex on the person

o the US GREflex on the assignment

o external bank account validation

o address validation

Until flexfield APIs become part of the standard product, validation of these flex
structures for legislations other than US and GB needs to be written by localization teams
as required.
File Name Package Name Business Process Comments

peempapi.pk hr_employee_api create_employee

h
peempapi.pk hr_employee_api create_gb_employee wrapper for
h create_employee
with GB flex
segment names
peempapi.pk hr_employee_api create_us_employee
h
peempapi.p hr_employee_api re_hire_ex_employee
kh
peexeapi.pk hr_ex_employee_api actual_termination_emp
h
peexeapi.pk hr_ex_employee_api final_process_emp
h
peexeapi.pk hr_ex_employee api update_term_details_emp updating
h termination
information such as
leaving reason and
termination dates
peappapi.pk hr_applicant_api create_applicant
h
peappapi.pk hr_applicant_api create_us_applicant
h
peappapi.pk hr_applicant_api create_gb_applicant
h
peappapi.pk hr_applicant_api hire_applicant
h
peperapi.pkh hr_person_api update_person
peperapi.pkh hr_person_api update_gb_person wrapper for
update_employee
with GB flex
segment names
peperapi.pkh hr_person_api update_us_person
peconapi.pk hr_contact_api create_personof type Other - not an Employee or
h Applicant
pecrlapi.pkh hr_contact_rel_api create_contact
pecrlapi.pk hr_contact_rel_api update_contact_relationshi
h p
pecrlapi.pk hr_contact_rel_api delete_contact_relationship
h
pephnapi.p hr_phone_api create_phone
kh
pephnapi.p hr_phone_api update_phone
kh
pephnapi.p hr_phone_api delete_phone
kh
peasgapi.pkh hr_assignment_api activate_emp_asg
peasgapi.pkh hr_assignment_api create_secondary_emp_asg
peasgapi.pkh hr_assignment_api create_us_secondary_emp_a
sg
peasgapi.pkh hr_assignment_api create_gb_secondary_emp_a
sg
peasgapi.pkh hr_assignment_api suspend_emp_asg
peasgapi.pkh hr_assignment_api update_emp_asg
peasgapi.pkh hr_assignment_api update_us_emp_asg
peasgapi.pkh hr_assignment_api update_gb_emp_asg
peasgapi.pkh hr_assignment_api update_emp_asg_criteria
peasgapi.pkh hr_assignment_api update_apl_asg
peasgapi.pkh hr_assignment_api create_secondary_apl_asg
peasgapi.pkh hr_assignment_api offer_apl_asg
peasgapi.pkh hr_assignment_api actual_termination_emp_asg
peasgapi.pkh hr_assignment_api final_process_emp_asg
peaplapi.pkh hr_application_api update_apl_details
peaddapi.pk hr_person_address_api1 create_person_address
h
peaddapi.pk hr_person_address_api create_gb_person_address wrapper for
h create_person_addr
ess with GB flex
segment names
peaddapi.pk hr_person_address_api create_us_person_address wrapper for
h create_person_addr
ess with US flex
segment names
peaddapi.pk hr_person_address_api1 update_person_address
h
peaddapi.pk hr_person_address_api update_gb_person_address wrapper for
h update_person_add
ress with GB flex
segment names
peaddapi.pk hr_person_address_api update_us_person_address wrapper for
h update_person_add
ress with US flex
segment names
pesitapi.pkh hr_sit_api create_sit
pesitapi.pkh hr_sit_api update_sit
pyppmapi.pk hr_personal_pay_method create_personal_pay_method
h _api
pyppmapi.pk hr_personal_pay_method create_us_personal_pay_met
h _api hod
pyppmapi.pk hr_personal_pay_method create_gb_personal_pay_met
h _api hod
pyppmapi.pk hr_personal_pay_method update_personal_pay_metho
h _api d
pyppmapi.pk hr_personal_pay_method update_us_personal_pay_me
h _api thod
pyppmapi.pk hr_personal_pay_method update_gb_personal_pay_me
h _api thod
pyppmapi.pk hr_personal_pay_method delete_personal_pay_method
h _api
hrpypapi.pk hr_upload_proposal_api upload_salary_proposal
h
pyeleapi.pkh py_element_entry_api create_element_entry
pyeleapi.pkh py_element_entry_api delete_element_entry
pyeleapi.pkh py_element_entry_api update_element_entry
pygrrapi.pkh hr_grade_api create_grade_rate_value
pygrrapi.pkh hr_grade_api delete_grade_rate_value
pygrrapi.pkh hr_grade_api update_grade_rate_value
pypsrapi.pkh hr_pay_scale_api create_pay_scale_value
pypsrapi.pkh hr_pay_scale_api delete_pay_scale_value
pypsrapi.pkh hr_pay_scale_api update_pay_scale_value
peposapi hr_position_api create_position
pypsrapi.pkh hr_position_api update_position
pepsrapi.pkh hr_position_requirement create_position_requirement
_api
pejobapi.pk hr_job_api create_job
h
pejbrapi.pkh hr_job_requirement_api create_job_requirement
pemmvapi.p hr_mass_move_api mass_move
kh
pevgrapi.pkh hr_valid_grade_api create_valid_grade
hrabmapi.pk hr_batch_message_line_ create_message_line
h api
hrabmapi.pk hr_batch_message_line_ delete_message_line
h api
hrabmapi.pk hr_batch_message_line_ delete_batch_lines
h api
peaprapi.pk hr_appraisals_api create_appraisal
h
peaprapi.pk hr_appraisals_api update_appraisal
h
peaprapi.pk hr_appraisals_api delete_appraisal
h
peaptapi.pk hr_appraisal_templates create_appraisal_template
h _api
peaptapi.pk hr_appraisal_templates update_appraisal_template
h _api
peaptapi.pk hr_appraisal_templates delete_appraisal_template
h _api
peasnapi.pk hr_assessments_api create_assessment
h
peasnapi.pk hr_assessments_api update_assessment
h
peasnapi.pk hr_assessments_api delete_assessment
h
peasrapi.pk hr_assessment_groups_ create_assessment_group
h api
peasrapi.pk hr_assessment_groups_ update_assessment_group
h api
peasrapi.pk hr_assessment_groups_ delete_assessment_group
h api
peastapi.pk hr_assessment_types_a create_assessment_type
h pi
peastapi.pk hr_assessment_types_a update_assessment_type
h pi
peastapi.pk hr_assessment_types_a delete_assessment_type
h pi
pecelapi.pk hr_competence_elemen create_competence_elemen
h t_api t
pecelapi.pk hr_competence_elemen update_competence_eleme
h t_api nt
pecelapi.pk hr_competence_elemen update_personal_comp_ele
h t_api ment
pecelapi.pk hr_competence_elemen delete_competence_elemen
h t_api t
pecelapi.pk hr_competence_elemen maintain_student_comp_el
h t_api ement
pecelapi.pk hr_competence_elemen copy_competencies
h t_api
pecelapi.pk hr_competence_elemen update_delivered_dates
h t_api
pecpnapi.pk hr_competences_api create_competence
h
pecpnapi.pk hr_competences_api update_competence
h
pecpnapi.pk hr_competences_api delete_objective
h
peparapi.pk hr_participants_api create_participant
h
peparapi.pk hr_participants_api update_participant
h
peparapi.pk hr_participants_api delete_participant
h
peprtapi.pk hr_performance_rating create_performance_rating
h s_api
peprtapi.pk hr_performance_rating update_performance_ratin
h s_api g
peprtapi.pk hr_performance_rating delete_performance_rating
h s_api
perscapi.pk hr_rating_scales_api create_rating_scale
h
perscapi.pk hr_rating_scales_api update_rating_scale
h
perscapi.pk hr_rating_scales_api delete_rating_scale
h
pertlapi.pk hr_rating_levels_api create_rating_level
h
pertlapi.pk hr_rating_levels_api update_rating_level
h
pertlapi.pk hr_rating_levels_api delete_rating_level
h
peahcapi.pk hr_api_hook_call_api create_api_hook_call for defining which
h customer specific
package procedures
should be executed
from which user
hooks
peahcapi.pk hr_api_hook_call_api update_api_hook_call
h
peahcapi.pk hr_api_hook_call_api delete_api_hook_call
h
Table 1 - 1. Publicly Callable Business Process APIs in Release 11.0