You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 23
Next »
Department API can perform functions to interact or exchange data with Department.
| Name | Description |
|---|
| 1 | | Name | Description |
|---|
| URL | /department | | HTTP Method | POST | | Body Parameters | | Parameter | Description |
|---|
| id | Department ID. | | name | Department name. | | description | Description of department. | | organization | | Key | Description |
|---|
| id | ID of the organization that this department belongs to. |
|
| | Sample Response |
{
"id": "apiTestDept",
"name": "API TEST Department",
"description": "This is a department created by API.",
"organization": {
"id": "ORG-001"
}
}
|
|
| 2 | Assign user to department |
Assign a Joget user to a department.
Name | Description |
|---|
| URL | /department/assignUser/{department}/{username} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| department | Department ID. | | username | Username of Joget user. |
| | Sample Response |
{
"userId": "cat",
"startDate": null,
"endDate": null,
"employeeCode": "",
"gradeId": "G-003",
"departmentId": "apiTestDept",
"organizationId": "ORG-001"
}
|
|
| 3 | |
Delete a department via department ID.
Name | Description |
|---|
| URL | /department/{id} | | HTTP Method | DELETE | | Path Parameters | | Parameter | Description |
|---|
| id | Department ID. |
| | Sample Response |
{
"date": "Wed Aug 28 01:29:38 SGT 2019",
"code": "200",
"message": "Successful operation"
}
|
|
| 4 | |
Gets all departments from all organizations by default. Able to filter or sort the returned results via parameters.
Name | Description |
|---|
| URL | /department/find | | HTTP Method | GET | | Query String Parameters | | Parameter | Description |
|---|
| nameFilter | Filters the response via department ID. | | organizationId | Filter departments that belong to an organization, via organization ID. | | sort | Department 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 |
[
{
"id": "D-001",
"name": "CEO Office",
"description": "",
"organization": {
"id": "ORG-001"
}
},
{
"id": "D-002",
"name": "Human Resource and Admin",
"description": "",
"organization": {
"id": "ORG-001"
}
},
.....
]
|
|
| 5 | |
Get details of a department via department ID.
Name | Description |
|---|
| URL | /department/{id} | | HTTP Method | GET | | Path Parameters | | Parameter | Description |
|---|
| id | Department ID. |
| | Sample Response |
{
"id": "D-001",
"name": "CEO Office",
"description": "",
"organization": {
"id": "ORG-001"
}
}
|
|
| 6 | Unassign user from department |
Unassign a Joget user from a department.
Name | Description |
|---|
| URL | /department/unassignUser/{department}/{username} | | HTTP Method | DELETE | | Path Parameters | | Parameter | Description |
|---|
| department | Department ID. | | username | Username of Joget user. |
| | Sample Response |
{
"date": "Thu Dec 05 03:29:56 SGT 2019",
"code": "200",
"message": "Successful operation"
}
|
|
| 7 | |
Update the details of a department.
Name | Description |
|---|
| URL | /department | | HTTP Method | PUT | | Body Parameters | | Parameter | Description |
|---|
| id | Department ID. | | name | Department name. | | description | Description of department. |
| | Sample Response |
{
"id": "apiTestDept",
"name": "API TEST Department",
"description": "I update this department description via API.",
"organization": {
"id": "ORG-001"
}
}
|
|