Creating and updating onboarding requests through web API
Before you begin
The employee record of the new hire must already be added to the people data in BMC Helix ITSM. Learn how to add a new record in Creating and modifying People data.
To raise an onboarding request by using the web API
Use the following web API to raise an onboarding request:
URL
{{hostname}}/api/rx/application/command
Method
Post
Details to be specified in the API
New hire login ID - Enter the new hire's login ID.
New hire gender* - Enter the new hire's gender by entering one of the following options: - Male (10), Female (20), Other (30).
First Name - First name of the new employee. Specify this information to create an entry in the Foundation data for the new employee.
Last Name - Last name of the new employee. Specify this information to create an entry in the Foundation data for the new employee.
New Hire Email ID - Company email ID of the new employee. Specify this information to create an entry in the Foundation data for the new employee.
Hiring manager* - Enter the new hire's hiring manager. This field expects login ID or GUID.
Recruitment manager* - Enter the new hire's recruitment manager. This field expects login ID or GUID.
Manager* - Enter the new hire's manager. This field expects login ID or GUID.
Buddy - Enter the new hire's buddy. This field expects login ID or GUID.
Job requisition ID* - Enter the job requisition ID.
Job title* - Enter the new hire's job title.
Joining date* - Enter the joining date of the new hire in format yyyy-mm-dd.
New hire contact number - Enter the new hire's contact number.
Requester - Enter requester if requester is different than the submitter. This field expects login ID or GUID.
Company* – Enter company of the new hire.
Organization - Enter the organization of the new hire.
Department - Enter the department of the new hire.
Location type - Enter the new hire's location type by entering one of the following options: - Remote (10), Onsite (20). Onsite is the default value.
Joining location* - Enter the new hire's joining location.
Employment Type* - Enter the employment type.
Employee Type* - Enter the employee type.
Activity notes - Enter additional notes to log it in case activity notes
"processDefinitionName": "com.bmc.dsm.hrsm-lib:Onboarding - Create request using interface",
"processInputValues": {
"New hire login ID": "michael@testmail.com",
"New hire gender": "Male",
"First Name": "Michael",
"Last Name": "Kingsley",
"New hire email ID": "mkingsley@apexglobal.com",
"Hiring manager": "Wren",
"Recruitment manager": "Wren",
"Manager": "Wren",
"Buddy": "Oliver",
"Job requisition ID": "JR-0000201",
"Job title": "Lead SQA",
"Joining date": "2024-02-12",
"New Hire Contact Number": "###",
"Requester": null,
"Company": "Apex Global",
"Organization": "",
"Department": "",
"Location type": "Remote",
"Joining location": "Apex Site",
"Employment type": "Employee",
"Employee type": "Seasonal",
"Activity notes": null
},
"resourceType": "com.bmc.arsys.rx.application.process.command.StartProcessInstanceCommand"
}
Result
After the successful creation of the onboarding request, you'll get the Onboarding request ID, Case display ID, and Case ID for that request.
To update an onboarding request by using the web API
URL
Method
Post
Details to be specified in the API
Onboarding request ID - Enter the onboarding request GUID of a record which needs to be updated
New hire personal email - Enter the new hire personal email whose record needs to be updated
(Note - Onboarding request ID or New hire personal email are required field. These two are used to get the Onboarding Request Record. You can pass any one of these two to fetch the record)
Status – Enter the onboarding request status (Upcoming, In Progress, Completed, Canceled, and Closed)
New hire contact number - Enter the new hire's contact number.
Hiring manager - Enter the hiring manager login ID or record ID
Recruitment manager - Enter the recruitment manager login ID or record ID
Manager - Enter the manager login ID or record ID
Buddy - Enter the buddy login ID or Record ID
Job title - Enter the new hire's job title
Joining Date - Enter the joining date in yyyy-mm-dd format
Location type - Enter the new hire's location type by entering one of the following options: - Remote (10), Onsite (20)
Joining location - Enter the new hire's joining location
Employment type - Enter the employment type
Employee type - Enter the employee type
Activity notes - Enter additional notes to log in case activity notes.
"processDefinitionName": "com.bmc.dsm.hrsm-lib:Onboarding - Update request using interface",
"processInputValues": {
"Joining date": "2023-03-30",
"Onboarding request ID": "AGGJYFPGCGR1IARRZ1XWRRZ1XWG2Z2"
},
"resourceType": "com.bmc.arsys.rx.application.process.command.StartProcessInstanceCommand"
}
Result
The onboarding request is modified with the updated information.