...
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
| Panel |
|---|
| title | API lấy danh sách phân hệ |
|---|
|
Method | GET | URL | system/module/list |
|---|
Description | API lấy danh sách phân hệ |
|---|
Note |
|
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | name | false | String | tên phân hệ |
|
| | 2 | ignoredModuleId | false | Integer | id phân hệ - lọc để không tìm kiếm id này |
|
| | 3 | page | true | Integer |
|
|
| | 4 | limit | true | Integer |
|
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
| | 3 | result | Object | Object |
|
| | 4 | (result) loadMoreAble | Boolean |
|
|
| | 5 | (result) page | Integer |
|
|
| | 6 | (result) preLoadAble | Integer |
|
|
| | 7 | (result) total | Integer |
|
|
| | 8 | (result) items | List<Object> | |
|
| | 9 | (items) id | Integer | Id phân hệ |
|
| | 10 | (items) name | String | tên phân hệ |
|
| | 11 | (items) position | Integer | vị trí hiển thị |
|
| | 12 | (items) active | Integer | Trạng thái (0: inactive, 1: active) |
|
| | 13 | (items) parentName | String | tên phân hệ cha |
|
| | 14 | (items) parentId | Integer | id phân hệ cha |
|
| | 15 | (items) hasResource | Integer | đánh dấu xem phân hệ này có cấu hình chức năng hay không (0: không cấu hình, 1: có cấu hình) |
|
| | 16 | (items) resources | List<Object> | Danh sách chức năng |
|
| | 17 | (items) children | List<Object> | Danh sách phân hệ con |
|
| | 18 | (resources) id | Integer | id chức năng |
|
| | 19 | (resources) name | String | tên chức năng |
|
| | 20 | (resources) description | String | mô tả chức năng |
|
| | 21 | (resources) code | String | mã chức năng |
|
| | 22 | (resources) uri | String | uri chức năng |
|
| | 23 | (resources) actions | String | actions chức năng |
|
| | 24 | (resources) active | Integer | trạng thái chức năng (0: inactive, 1: active) |
|
| | 25 | (children) id | Integer | Id phân hệ con |
|
| | 26 | (children) name | String | tên phân hệ con |
|
| | 27 | (children) position | Integer | vị trí hiển thị con |
|
| | 28 | (children) active | Integer | Trạng thái (0: inactive, 1: active) |
|
| | 29 | (children) parentName | String | tên phân hệ cha |
|
| | 30 | (children) parentId | Integer | id phân hệ cha |
|
| | 31 | (children) hasResource | Integer | đánh dấu xem phân hệ này có cấu hình chức năng hay không (0: không cấu hình, 1: có cấu hình) |
|
| | 32 | (children) resources | List<Object> | Danh sách chức năng phân hệ con |
|
| | 33 | (children) children | List<Object> | Danh sách phân hệ con |
|
|
|
| Panel |
|---|
| title | API Spec xem thông tin chi tiết 1 phân hệ |
|---|
|
Method | Get | URL | system/module/get |
|---|
Description | API lấy thông tin chi tiết của 1 phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. ParamSTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id phân hệ |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) id | Integer | Id phân hệ |
| | 5 | (result) name | String | Tên phân hệ |
| | 6 | (result) parentName | String | tên phân hệ cha |
| | 7 | (result) parentId | Integer | id phân hệ cha |
| | 8 | (result) position | Integer | vị trí |
| | 9 | (result) active | Integer | trạng thái chức năng (0: inactive, 1: active) |
|
|
| Panel |
|---|
| title | API thêm mới phân hệ |
|---|
|
Method | POST | URL | system/module/insert |
|---|
Description | API thêm mới phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | name | true | String | tên phân hệ |
| | 2 | active | true | Integer | trạng thái phân hệ (0: inactive, 1:active) |
| | 3 | app | true | String | mặc định BPM |
| | 4 | parentId | false | Integer | id phân hệ cha |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) id | Integer | id phân hệ |
| | 5 | (result) name | String | tên phân hệ |
| | 6 | (result) active | Integer | trạng thái phân hệ (0: inactive, 1:active) |
| | 7 | (result) app | String |
|
| | 8 | (result) parentId | Integer | id phân hệ cha |
|
|
| Panel |
|---|
| title | API chỉnh sửa phân hệ |
|---|
|
Method | PUT | URL | system/module/update |
|---|
Description | API chỉnh sửa phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | name | true | String | tên phân hệ |
| | 2 | active | true | Integer | trạng thái phân hệ (0: inactive, 1:active) |
| | 3 | app | true | String | mặc định BPM |
| | 4 | parentId | false | Integer | id phân hệ cha |
| | 5 | id | true | Integer | id phân hệ |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) id | Integer | id phân hệ |
| | 5 | (result) name | String | tên phân hệ |
| | 6 | (result) active | Integer | trạng thái phân hệ (0: inactive, 1:active) |
| | 7 | (result) app | String |
|
| | 8 | (result) parentId | Integer | id phân hệ cha |
|
|
| Panel |
|---|
| title | API cập nhật trạng thái phân hệ |
|---|
|
Method | PUT | URL | system/module/updateStatus |
|---|
Description | API cập nhật trạng thái phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id phân hệ |
| | 2 | active | true | Integer | trạng thái phân hệ (0: inactive, 1:active) |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) id | Integer | id phân hệ |
| | 5 | (result) active | Integer | trạng thái phân hệ (0: inactive, 1:active) |
|
|
| Panel |
|---|
| title | API cập nhật thứ tự phân hệ |
|---|
|
Method | PUT | URL | system/module/reorderModule |
|---|
Description | API cập nhật thứ tự phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id phân hệ |
| | 2 | parentId | true | Integer | id phân hệ cha |
| | 3 | oldPosition | true | Integer | vị trí cũ |
| | 4 | newPosition | true | Integer | vị trí mới |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
|
|
| Panel |
|---|
|
Method | DELETE | URL | system/module/delete |
|---|
Description | API xóa phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id phân hệ |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) totalDeleted | Integer | số bản ghi đã xóa |
| | 5 | (result) modules | List<Object> | danh sách các modules |
| | 6 | (modules) id | Integer | id phân hệ |
| | 7 | (modules) name | String | tên phân hệ |
|
|
| Panel |
|---|
| title | API xóa nhiều phân hệ |
|---|
|
Method | POST | URL | system/module/deleteBatch |
|---|
Description | API xóa nhiều phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | ids | true | List<Integer> | danh sách id phân hệ cần xóa |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) totalDeleted | Integer | số bản ghi đã xóa |
| | 5 | (result) modules | List<Object> | danh sách các modules |
| | 6 | (modules) id | Integer | id phân hệ |
| | 7 | (modules) name | String | tên phân hệ |
|
|
| Panel |
|---|
| title | API thêm mới chức năng vào phân hệ |
|---|
|
Method | POST | URL | system/moduleResource/insertBatch |
|---|
Description | API thêm mới chức năng vào phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | moduleId | true | Integer | id phân hệ |
| | 2 | resourceIds | true | List<Integer> | danh sách id chức năng |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | List<Object> | List<Object> |
| | 4 | (result) id | Integer |
|
| | 5 | (result) moduleId | Integer | id phân hệ |
| | 6 | (result) resourceId | Integer | id chức năng |
| | 7 | (result) position | Integer | vị trí |
|
|
| Panel |
|---|
| title | API xóa chức năng vào phân hệ |
|---|
|
Method | POST | URL | system/moduleResource/deleteBatch |
|---|
Description | API xóa chức năng vào phân hệ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | moduleId | true | Integer | id phân hệ |
| | 2 | resourceIds | true | List<Integer> | danh sách id chức năng cần xóa |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Integer | số lượng đã xóa |
|
|
3.4 Mô tả các trường dữ liệu trên màn hình:
...
