Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescription
1

Anchor
Add grade
Add grade
Add grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Add a new grade.

Name

Description
URL/grade
HTTP MethodPOST
Body Parameters
ParameterDescription
idGrade ID.
nameGrade name.
descriptionDescription of grade.
organization
KeyDescription
idID of the organization that this grade belongs to.
Sample Response
Code Block
languagejs
{
  "id": "apiTestGrade",
  "name": "API Test Grade",
  "description": "This is a grade created by API.",
  "organization": {
    "id": "ORG-001"
  }
}
2

Anchor
Assign user to grade
Assign user to grade
Assign user to grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Assign a Joget user to a grade.

Name

Description
URL/grade/assignUser/{grade}/{username}
HTTP MethodPOST
Path Parameters
ParameterDescription
gradeGrade ID.
usernameUsername of Joget user.
Sample Response
Code Block
languagejs
{
  "userId": "cat",
  "startDate": null,
  "endDate": null,
  "employeeCode": "",
  "gradeId": "apiTestGrade",
  "departmentId": null,
  "organizationId": "ORG-001"
}
3

Anchor
Delete grade
Delete grade
Delete grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Delete a grade via grade ID.

Name

Description
URL/grade/{id}
HTTP MethodDELETE
Path Parameters
ParameterDescription
idGrade ID.
Sample Response
Code Block
languagejs
{
  "date": "Wed Aug 28 15:43:58 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
4

Anchor
Find grade
Find grade
Find grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Gets all grades from all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/grade/find
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterFilters the response via grade ID.
organizationIdFilter grades that belong to an organization, via organization ID.
sort

Grade data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "id": "G-001",
    "name": "Board Members",
    "description": ""
  },
  {
    "id": "G-002",
    "name": "Managers",
    "description": ""
  },
	.....
]
5

Anchor
Get grade by ID
Get grade by ID
Get grade by ID

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get details of a grade via grade ID.

Name

Description
URL/grade/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idGrade ID.
Sample Response
Code Block
languagejs
{
  "id": "G-001",
  "name": "Board Members",
  "description": ""
}
6

Anchor
Unassign user from grade
Unassign user from grade
Unassign user from grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Unassign a Joget user from a grade.

Name

Description
URL/grade/unassignUser/{grade}/{username}
HTTP MethodDELETE
Path Parameters
ParameterDescription
gradeGrade ID.
usernameUsername of Joget user.
Sample Response
Code Block
languagejs
{
  "date": "Thu Dec 05 03:29:56 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
7

Anchor
Update grade
Update grade
Update grade

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Update the details of a grade.

Name

Description
URL/grade
HTTP MethodPUT
Body Parameters
ParameterDescription
idGrade ID.
nameGrade name.
descriptionDescription of grade.
organization
KeyDescription
idID of the organization that this grade belongs to.
Sample Response
Code Block
languagejs
{
  "id": "apiTestGrade",
  "name": "API Test Grade",
  "description": "This grade is updated via API.",
  "organization": {
    "id": "ORG-001"
  }
}