Grade API can interact with Grade and its users in the Joget built-in directory manager.
Add grade
Add a new grade.
Name
{ "id": "apiTestGrade", "name": "API Test Grade", "description": "This is a grade created by API.", "organization": { "id": "ORG-001" } }
Assign user to grade
Assign a Joget user to a grade.
{ "userId": "cat", "startDate": null, "endDate": null, "employeeCode": "", "gradeId": "apiTestGrade", "departmentId": null, "organizationId": "ORG-001" }
Delete grade
Delete a grade via grade ID.
{ "date": "Wed Aug 28 15:43:58 SGT 2019", "code": "200", "message": "Successful operation" }
Find grade
Gets all grades from all organizations by default.
Able to filter or sort the returned results via parameters.
Grade data column to sort.
Must be used in conjunction with "sortDescending" parameter.
Sort the specified "sort" parameter value in ascending or descending order.
Expects a boolean value.
Must be used in conjunction with "sort" parameter.
[ { "id": "G-001", "name": "Board Members", "description": "", "organization": { "id": "ORG-001" } }, { "id": "G-002", "name": "Managers", "description": "", "organization": { "id": "ORG-001" } }, ..... ]
Get grade by ID
Get details of a grade via grade ID.
{ "id": "G-001", "name": "Board Members", "description": "", "organization": { "id": "ORG-001" } }
Unassign user from grade
Unassign a Joget user from a grade.
{ "date": "Thu Dec 05 03:29:56 SGT 2019", "code": "200", "message": "Successful operation" }
Update grade
Update the details of a grade.
{ "id": "apiTestGrade", "name": "API Test Grade", "description": "This grade is updated via API.", "organization": { "id": "ORG-001" } }