Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Versions Compared

Key

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

...


NameDescription
1

Anchor
Add user
Add user
Add user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Add a new user account.

Name

Description
URL/user
HTTP MethodPOST
Body Parameters
ParameterDescription
idUser ID of user.
username

Username of user.

passwordUser's password.
firstNameUser's first name.
lastNameUser's last name.
emailUser's email.
activeUser's account active status.
timeZoneUser's time zone.
localeUser's locale.
Sample Response
Code Block
languagejs
{
  "id": "apiUser",
  "username": "apiUser",
  "firstName": "API",
  "lastName": "User",
  "email": "",
  "active": 1,
  "timeZone": "",
  "locale": ""
}
2

Anchor
Delete user
Delete user
Delete user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Delete a user account.

Name

Description
URL/user/{username}
HTTP MethodDELETE
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
{
  "date": "Fri Aug 30 00:38:43 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
3

Anchor
Find HOD by username
Find HOD by username
Find HOD by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Find the HOD of the department that the specified user belongs to, via username.

Name

Description
URL/user/findHod/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
[
  {
    "id": "clark",
    "username": "clark",
    "firstName": "Clark",
    "lastName": "Kent",
    "email": "",
    "active": 1,
    "timeZone": "",
    "locale": null
  }
]
4

Anchor
Find subordinate by username
Find subordinate by username
Find subordinate by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Find all users that report to the specified user, via username.

Name

Description
URL/user/findSubordinate/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
[
  {
    "id": "clark",
    "username": "clark",
    "firstName": "Clark",
    "lastName": "Kent",
    "email": "",
    "active": 1,
    "timeZone": "",
    "locale": null
  },
	.....
]
5

Anchor
Find user
Find user
Find user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get user details of all users by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/user/find
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterFilters the response via user ID.
organizationIdFilter users that belong to an organization, via organization ID.
departmentIdFilter users that belong to a department, via department ID.
gradeIdFilter users that belong to a grade, via grade ID.
groupIdFilter users that belong to a group, via group ID.
roleIdFilter users that has such role (e.g: role_user OR role_admin).
active

Filter users by account active status.

1 for active, 0 for inactive.

sort

User 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": "admin",
    "username": "admin",
    "firstName": "Admin",
    "lastName": "Admin",
    "email": null,
    "active": 1,
    "timeZone": "0",
    "locale": null
  },
	.....
]
6

Anchor
Get Department HOD
Get Department HOD
Get Department HOD

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get user details of the HOD of the department, via department ID.

Name

Description
URL/user/findHodByDepartment/{departmentId}
HTTP MethodGET
Path Parameters
ParameterDescription
departmentIdDepartment ID.
Sample Response
Code Block
languagejs
{
  "id": "terry",
  "username": "terry",
  "firstName": "Terry",
  "lastName": "Berg",
  "email": "",
  "active": 1,
  "timeZone": "",
  "locale": null
}
7

Anchor
Get employment info
Get employment info
Get employment info

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get employment details of a user via username.

Name

Description
URL/user/employment/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
{
  "startDate": "Apr 1, 2019",
  "endDate": "Aug 29, 2019",
  "employeeCode": "JOGET-0098-D",
  "gradeId": "G-003",
  "departmentId": "D-005",
  "organizationId": "ORG-001"
}
8

Anchor
Get roles by username
Get roles by username
Get roles by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get the roles (e.g: regular user, Joget administrator) of a user via username.

Name

Description
URL/user/roles/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
[
  {
    "id": "ROLE_ADMIN",
    "name": "Admin",
    "description": "Administrator"
  },
  {
    "id": "ROLE_SYSADMIN",
    "name": "ROLE_SYSADMIN",
    "description": null
  }
]
9

Anchor
Get user by username
Get user by username
Get user by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get user details of a user via username.

Name

Description
URL/user/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
{
  "id": "cat",
  "username": "cat",
  "firstName": "Cat",
  "lastName": "Grant",
  "email": "",
  "active": 1,
  "timeZone": "8",
  "locale": null
}
10

Anchor
Update user
Update user
Update user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Update the user details of a user.

Name

Description
URL/user
HTTP MethodPUT
Body Parameters
Note
The user ID specified must be of an existing user, to update its details successfully.
ParameterDescription
idUser ID of user.
usernameUsername of user.
passwordUser's password.
firstNameUser's first name.
lastNameUser's last name.
emailUser's email.
activeUser's account active status.
timeZoneUser's time zone.
localeUser's locale.
Sample Response
Code Block
languagejs
{
  "id": "apiUser",
  "username": "apiUser",
  "firstName": "API",
  "lastName": "User Pro",
  "email": "apiUserPro@email.com",
  "active": 1,
  "timeZone": "8",
  "locale": ""
}

...