Start the offboarding of an employee
Start the offboarding of an employee who is leaving: writes their last day, creates the offboarding and its ticket, and opens its first steps as typed tasks according to the offboarding settings (the confirmation of the leaver information, then the access removal, the device handling and the return shipment). The steps run through their intent tools: read the tasks with getTicket, then updateOffboardingConfirmationIntent / executeOffboardingConfirmationIntent and the others. Refused with OFFBOARDING_TICKETS_NOT_ENABLED (403) when offboarding tickets are not enabled for the company, EMPLOYEE_NOT_FOUND, EMPLOYEE_HIDDEN, CANNOT_OFFBOARD_YOURSELF, OFFBOARDING_ALREADY_EXISTS (the employee already has an open offboarding: use getOffboardings), OFFBOARDING_IS_LEGACY (one on the steppers from before offboarding tickets), TERMINATION_DATE_REQUIRED (send terminationDate or set it on the employee), FAIL_TO_OPEN_OFFBOARDING_TICKET (502, nothing was created). To drop an offboarding that has not started, use ignoreOffboarding.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Body
The leaver, from getEmployees
^[a-f\d]{24}$The leaver's last day. Defaults to the termination date already on the employee.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
Whether the offboarding runs on the steppers from before offboarding tickets
PENDING, SCHEDULED, IN_PROGRESS, CLOSED, CANCELED COCKPIT, MERGE, KOMBO, API ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$The offboarding ticket, whose tasks are its steps (getTicket)
The reference the cockpit shows for that ticket
How the offboarding holds its steps: ACTIONS (the steppers from before offboarding tickets) or INTENTS (typed tasks under its ticket, run through the intent tools such as executeOffboardingConfirmationIntent). Null while it has neither a ticket nor a step.
ACTIONS, INTENTS