Marketplace Knowledge Base
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata
Definition

Grade API can interact with Grade and its users in the Joget built-in directory manager.


NameDescription
1

Add grade

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
{
  "id": "apiTestGrade",
  "name": "API Test Grade",
  "description": "This is a grade created by API.",
  "organization": {
    "id": "ORG-001"
  }
}
2

Assign user to grade

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
{
  "userId": "cat",
  "startDate": null,
  "endDate": null,
  "employeeCode": "",
  "gradeId": "apiTestGrade",
  "departmentId": null,
  "organizationId": "ORG-001"
}
3

Delete grade

Delete a grade via grade ID.

Name

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

Find grade

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
[
  {
    "id": "G-001",
    "name": "Board Members",
    "description": "",
    "organization": {
      "id": "ORG-001"
    }
  },
  {
    "id": "G-002",
    "name": "Managers",
    "description": "",
    "organization": {
      "id": "ORG-001"
    }
  },
	.....
]
5

Get grade by ID

Get details of a grade via grade ID.

Name

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

Unassign user from grade

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
{
  "date": "Thu Dec 05 03:29:56 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
7

Update grade

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
{
  "id": "apiTestGrade",
  "name": "API Test Grade",
  "description": "This grade is updated via API.",
  "organization": {
    "id": "ORG-001"
  }
}




  • No labels