Lấy danh sách mẫu quy trình

Ngày cập nhật: 18 tháng 08, 2026
Người cập nhật: VNPT eContract's team

---

Mục đích

Hàm lấy danh sách mẫu quy trình được tạo bởi người dùng hoặc được chia sẻ bởi các người dùng khác.

• Request URL: /api/process-templates
• HTTP method: GET
• Authorize: Bearer token
• Parameter: Không yêu cầu, tuy nhiên có thể thêm các tùy chọn bên dưới để thực hiện lọc hoặc tìm kiếm danh sách mẫu quy trình.

Key	Type	Description
search	string	Thông tin tìm kiếm theo tên mẫu quy trình
page	int	Số trang cần lấy dữ liệu (Mặc định hệ thống đang là 1)
pagesize	int	Số record dữ liệu mà hệ thống sẽ trả về sau mỗi request (Mặc định hệ thống đang là 10 record)

Mẫu request

Query param:
    page: 1
    pageSize:10
    search: Mẫu quy trình xử lý hợp đồng
Request: /api/process-templates?page=1&pageSize=10&search=Mẫu quy trình xử lý hợp đồng

Mẫu response body

{
    "data": {
        "items": [
            {
                "id": 1109,
                "name": "Mẫu quy trình xử lý hợp đồng",
                "createdDate": "2022-12-06T10:36:50.4321641",
                "processInOrder": false,
                "isPublic": true,
                "createdByUser": {
                    "id": 2341,
                    "code": "phannhan",
                    "name": "Phan Nhan",
                    "phone": "091938XXXX",
                    "email": "example@email.com"
                },
                "items": [
                    {
                        "accessPermission": {
                            "value": 2,
                            "description": "Sign draw"
                        },
                        "processedByUserId": 2341,
                        "processedByUser": {
                            "id": 2341,
                            "code": "phannhan",
                            "name": "Phan Nhan",
                            "email": "example@email.com",
                            "phone": "091938XXXX"
                        }
                    }
                ]
            }
        ],
        "totalCount": 1,
        "pageCount": 1,
        "page": 1,
        "pageSize": 10,
        "hasNextPage": false,
        "hasPreviousPage": false
    },
    "success": true,
    "code": 0,
    "messages": []
}

Mô tả Response Body

Key	Type	Description
success	boolean	Trạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại)
code	int	Mã phản hồi từ hệ thống
messages	array	Danh sách thông báo hoặc lỗi trả về từ hệ thống
data	object	Đối tượng chứa danh sách mẫu quy trình và thông tin phân trang (xem chi tiết bên dưới)

Chi tiết dữ liệu trong data:

Key	Type	Description
items	array	Danh sách các mẫu quy trình (Array[object]) (xem chi tiết bên dưới)
totalCount	int	Tổng số bản ghi tìm thấy
pageCount	int	Tổng số trang
page	int	Trang hiện tại
pageSize	int	Số lượng bản ghi trên một trang
hasNextPage	boolean	Có trang tiếp theo hay không (true: Có, false: Không)
hasPreviousPage	boolean	Có trang trước đó hay không (true: Có, false: Không)

Chi tiết danh sách items:

Danh sách chứa các đối tượng mẫu quy trình với các thuộc tính của 1 phần tử:

Key	Type	Description
id	int	ID mẫu quy trình
name	string	Tên mẫu quy trình
createdDate	string	Thời gian tạo mẫu quy trình (định dạng ISO 8601)
processInOrder	boolean	Cấu hình quy trình xử lý tuần tự (true: Xử lý tuần tự, false: Không tuần tự)
isPublic	boolean	Trạng thái công khai mẫu quy trình (true: Công khai/Chia sẻ, false: Riêng tư)
createdByUser	object	Thông tin chi tiết người tạo mẫu quy trình: { "id": "ID người dùng", "code": "Mã người dùng", "name": "Tên người dùng", "phone": "Số điện thoại", "email": "Email" }
items	array	Danh sách các bước/lượt xử lý trong quy trình (Array[object]) (xem chi tiết bên dưới)

Chi tiết các bước trong quy trình (items bên trong mẫu quy trình):

Danh sách chứa các lượt xử lý được thiết lập sẵn trong mẫu quy trình với các thuộc tính của 1 phần tử:

Key	Type	Description
accessPermission	object	Quyền xử lý chứng từ: {"value": int, "description": string} 1: View only 2: Sign draw 3: Approve 4: Sign digital 5: Fill data 6: Coordinate 7: E-Sign 8: eKYC sign
processedByUserId	int	ID của người dùng thực hiện xử lý ở bước này
processedByUser	object	Thông tin chi tiết của người dùng xử lý: { "id": "ID người dùng", "code": "Mã người dùng", "name": "Tên người dùng", "phone": "Số điện thoại", "email": "Email" }