Namespace Reference — Modules
HCM
Curated JQL namespaces and examples for hcm.
Human Capital Management covers employees, job roles, leave, salaries, performance, training, goals, announcements, timesheets, exit management, and HCM settings.
Key namespaces and models
hcm.Employeehcm.JobRolehcm.LeaveTypehcm.LeaveBalancehcm.LeaveRequesthcm.LeavePolicyhcm.EmployeeSalaryhcm.PayGradehcm.PerformanceReviewhcm.TrainingCoursehcm.TrainingEnrollmenthcm.Announcementhcm.Timesheethcm.HCMSettings
Common controller intents
hcm.HCM.getQuickStatshcm.HCM.getHeadcountAnalyticshcm.HCM.getLeaveSummaryhcm.LeaveRequest.getMyQuickStatshcm.Employee.getHolidayCalendarhcm.Timesheet.generateTenantWeeklyTimesheets
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
hcm.LeaveRequest consequences include approve, reject, cancel, submitForApproval, and recall (shorten approved leave; restore unused days). See /modules/hcm-leave-recall.
Retrieve example
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "hcm.Employee",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "hcm.JobRole",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Product Manager",
14 "alias": "product-manager"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.