Page History

Panel

borderColor	green
borderWidth	1
titleBGColor	#ddffcc
borderStyle	solid
title	Definition

Grade API can perform functions to interact or exchange data for Grade.

...

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

Image Added

Name

Description

1

Anchor

	Add grade
	Add grade

Add grade

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Add a new grade.

Name

Description

URL

/grade

HTTP Method

POST

Body Parameters

Parameter

Description

id

Grade ID.

name

Grade name.

description

Description of grade.

organization

Key	Description
id	ID of the organization that this grade belongs to.

Sample Response

Code Block

language	js

{
  "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

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Assign a Joget user to a grade.

Name

Description

URL

/grade/assignUser/{grade}/{username}

HTTP Method

POST

Path Parameters

Parameter	Description
grade	Grade ID.
username	Username of Joget user.

Sample Response

Code Block

language	js

{
  "userId": "cat",
  "startDate": null,
  "endDate": null,
  "employeeCode": "",
  "gradeId": "apiTestGrade",
  "departmentId": null,
  "organizationId": "ORG-001"
}

3

Anchor

	Delete grade
	Delete grade

Delete grade

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Delete a grade via grade ID.

Name

Description

URL

/grade/{id}

HTTP Method

DELETE

Path Parameters

Parameter	Description
id	Grade ID.

Sample Response

Code Block

language	js

{
  "date": "Wed Aug 28 15:43:58 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

4

Anchor

	Find grade
	Find grade

Find grade

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Gets all grades from all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description

URL

/grade/find

HTTP Method

GET

Query String Parameters

Parameter	Description
nameFilter	Filters the response via grade ID.
organizationId	Filter 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.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "id": "G-001",
    "name": "Board Members",
    "description": "",
    "organization": {
      "id": "ORG-001"
    }
  },
  {
    "id": "G-002",
    "name": "Managers",
    "description": "",
    "organization": {
      "id": "ORG-001"
    }
  },
	.....
]

5

Anchor

	Get grade by ID
	Get grade by ID

Get grade by ID

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get details of a grade via grade ID.

Name

Description

URL

/grade/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Grade ID.

Sample Response

Code Block

language	js

{
  "id": "G-001",
  "name": "Board Members",
  "description": "",
  "organization": {
    "id": "ORG-001"
  }
}

6

Anchor

	Unassign user from grade
	Unassign user from grade

Unassign user from grade

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Unassign a Joget user from a grade.

Name

Description

URL

/grade/unassignUser/{grade}/{username}

HTTP Method

DELETE

Path Parameters

Parameter	Description
grade	Grade ID.
username	Username of Joget user.

Sample Response

Code Block

language	js

{
  "date": "Thu Dec 05 03:29:56 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

7

Anchor

	Update grade
	Update grade

Update grade

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Update the details of a grade.

Name

Description

URL

/grade

HTTP Method

PUT

Body Parameters

Parameter

Description

id

Grade ID.

name

Grade name.

description

Description of grade.

organization

Key	Description
id	ID of the organization that this grade belongs to.

Sample Response

Code Block

language	js

{
  "id": "apiTestGrade",
  "name": "API Test Grade",
  "description": "This grade is updated via API.",
  "organization": {
    "id": "ORG-001"
  }
}

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key