Trong trang này
> tai nguyen > tai lieu > api > Tài liệu tham khảo API: quy trình

Tài liệu tham khảo API: quy trình

Các điểm cuối này hoạt động trong workspace của bạn. Bắt đầu dùng thử miễn phí để tạo workspace và thực hiện lệnh gọi API đầu tiên.

Liệt kê quy trình

Điểm cuối: GET /v1/tenant/{tenantId}/processes

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
limit integer query Không Số mục tối đa cần trả về
offset integer query Không Số mục cần bỏ qua

Phản hồi (200):

Danh sách quy trình

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key

Tạo quy trình (với mô hình trống)

Điểm cuối: POST /v1/tenant/{tenantId}/processes

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
Trường Kiểu Bắt buộc Mô tả
displayName string Có Tên quy trình hiển thị trong cây quy trình
Độ dài tối đa: 128
treeParentId string Không ID thư mục cha (null = cấp cao nhất)
Định dạng: uuid
treeNodeType Process | TreeGroup Không Quy trình hoặc TreeGroup (thư mục)
Giá trị cho phép: Process, TreeGroup
Mặc định: Process

Phản hồi (201):

Quy trình đã tạo

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
treeParentId string Có Định dạng: uuid
treeNodeType Process | TreeGroup Có Giá trị được phép: Process, TreeGroup
Mặc định: Process
displayName string Có Mặc định: New Process
Độ dài tối đa: 128
createdAt string Có Định dạng: date-time
updatedAt string Có Định dạng: date-time
designerModelId string Có Định dạng: uuid

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 500 Lỗi máy chủ ngoài dự kiến: bạn có thể gửi lại yêu cầu một cách an toàn

Lấy thông tin quy trình

Điểm cuối: GET /v1/tenant/{tenantId}/processes/{processId}

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid

Phản hồi (200):

Quy trình

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
treeParentId string Có Định dạng: uuid
treeNodeType Process | TreeGroup Có Giá trị được phép: Process, TreeGroup
Mặc định: Process
displayName string Có Mặc định: New Process
Độ dài tối đa: 128
createdAt string Có Định dạng: date-time
updatedAt string Có Định dạng: date-time
designerModelId string Có Định dạng: uuid

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 404 Không tìm thấy tài nguyên

Cập nhật quy trình

Điểm cuối: PUT /v1/tenant/{tenantId}/processes/{processId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
displayName string Không Tên quy trình hiển thị trong cây quy trình
Độ dài tối đa: 128
treeParentId string Không ID thư mục cha (null = cấp cao nhất)
Định dạng: uuid

Phản hồi (200):

Quy trình đã cập nhật

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
treeParentId string Có Định dạng: uuid
treeNodeType Process | TreeGroup Có Giá trị được phép: Process, TreeGroup
Mặc định: Process
displayName string Có Mặc định: New Process
Độ dài tối đa: 128
createdAt string Có Định dạng: date-time
updatedAt string Có Định dạng: date-time
designerModelId string Có Định dạng: uuid

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 404 Không tìm thấy tài nguyên
  • 500 Lỗi máy chủ ngoài dự kiến: bạn có thể gửi lại yêu cầu một cách an toàn

Xóa mềm quy trình

Điểm cuối: DELETE /v1/tenant/{tenantId}/processes/{processId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid

Phản hồi (200):

Đã xóa quy trình

{
	"success": true,
	"message": "string"
}
Trường Kiểu Bắt buộc Mô tả
success boolean Có
message string Có

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 404 Không tìm thấy tài nguyên

Xuất mô hình quy trình dưới dạng BPMN 2.0 XML

Điểm cuối: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid

Phản hồi (200):

BPMN XML

{
	"bpmnXml": "string"
}
Trường Kiểu Bắt buộc Mô tả
bpmnXml string Có BPMN 2.0 XML

Lỗi:

  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 403 API key không có phạm vi cần thiết hoặc quyền truy cập tổ chức; tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
  • 404 Không tìm thấy tài nguyên
  • 500 Lỗi máy chủ ngoài dự kiến: bạn có thể gửi lại yêu cầu một cách an toàn

Nhập mô hình BPMN 2.0 cho quy trình (thay thế mô hình hiện tại)

Điểm cuối: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid

Nội dung yêu cầu:

{
	"bpmnXml": "string"
}
Trường Kiểu Bắt buộc Mô tả
bpmnXml string Có BPMN 2.0 XML

Phản hồi (200):

Đã tải BPMN lên

{
	"message": "string"
}
Trường Kiểu Bắt buộc Mô tả
message string Có

Lỗi:

  • 400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc đã hết hạn API key
  • 404 Không tìm thấy tài nguyên

Ánh xạ dữ liệu kết nối các bảng dữ liệu với quy trình, giúp bạn trực quan hóa và phân tích dữ liệu nhật ký sự kiện trên mô hình quy trình.

Liệt kê ánh xạ dữ liệu của quy trình

Điểm cuối: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string path Có Định dạng: uuid
processId string path Có Định dạng: uuid
limit integer query Không Số mục tối đa cần trả về
offset integer query Không Số mục cần bỏ qua

Phản hồi (200):

Danh sách ánh xạ

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Ánh xạ datatable vào quy trình (bắt đầu xử lý nhật ký sự kiện)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
Trường Kiểu Bắt buộc Mô tả
dataTableId string Có Datatable cần ánh xạ vào quy trình
Định dạng: uuid
displayName string Không Tên hiển thị của ánh xạ
Độ dài tối đa: 128
color object Không Màu nhấn
showByDefault boolean Không Mặc định hiển thị ánh xạ này trong chế độ xem quy trình
Mặc định: true
mappingRole primary | comparison Không Vai trò của dữ liệu được ánh xạ trong mô hình
Giá trị cho phép: primary, comparison

Phản hồi (201):

Đã tạo ánh xạ

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
modelId string Có Định dạng: uuid
dataTableId string Có Định dạng: uuid
displayName string Có Độ dài tối đa: 128
color object Có
showByDefault boolean Có Mặc định: true
mappingRole primary | comparison Có Giá trị cho phép: primary, comparison
Mặc định: comparison
sortOrder integer Có Mặc định: 0
Tối thiểu: -9007199254740991
Tối đa: 9007199254740991

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 403 API key không có phạm vi hoặc quyền truy cập tổ chức cần thiết, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
  • 404 Không tìm thấy tài nguyên

Cập nhật ánh xạ

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
mappingId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Trường Kiểu Bắt buộc Mô tả
displayName string Không Độ dài tối đa: 128
color object Không
showByDefault boolean Không
mappingRole primary | comparison Không Giá trị cho phép: primary, comparison
sortOrder integer Không Tối thiểu: -9007199254740991
Tối đa: 9007199254740991

Phản hồi (200):

Ánh xạ đã cập nhật

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
modelId string Có Định dạng: uuid
dataTableId string Có Định dạng: uuid
displayName string Có Độ dài tối đa: 128
color object Có
showByDefault boolean Có Mặc định: true
mappingRole primary | comparison Có Giá trị cho phép: primary, comparison
Mặc định: comparison
sortOrder integer Có Mặc định: 0
Tối thiểu: -9007199254740991
Tối đa: 9007199254740991

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Xóa ánh xạ

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
mappingId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Đã xóa ánh xạ

{
	"success": true,
	"message": "string"
}
Trường Kiểu Bắt buộc Mô tả
success boolean Có
message string Có

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Các endpoint này dùng AI để tự động tạo mô hình quy trình BPMN từ mô tả bằng ngôn ngữ tự nhiên.

Tạo mô hình quy trình từ yêu cầu bằng ngôn ngữ tự nhiên (xử lý bất đồng bộ; kiểm tra endpoint trạng thái)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Xác thực: API key giới hạn theo tenant · phạm vi write · giới hạn tốc độ 2 yêu cầu/giây (tối đa 4 yêu cầu dồn)

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"prompt": "string"
}
Trường Kiểu Bắt buộc Mô tả
prompt string Có

Phản hồi (200):

Đã bắt đầu tạo / kết quả

{
	"message": "string"
}
Trường Kiểu Bắt buộc Mô tả
message string Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Kiểm tra trạng thái tạo mô hình

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Trạng thái tạo mô hình

{
	"message": "string"
}
Trường Kiểu Bắt buộc Mô tả
message string Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Các chỉ số theo từng case của mô hình mới nhất của quy trình: mỗi hàng tương ứng với một case, gồm chuỗi hoạt động và các chỉ số sức khỏe đã tính.

Lấy chỉ số theo từng case của quy trình (mô hình mới nhất, có phân trang)

Trả về một hàng cho mỗi case, gồm các chỉ số quy trình đã tính (thời lượng, độ dài, mức độ tuân thủ, công việc làm lại, điểm sức khỏe, biến thể và các chỉ số khác) từ mô hình mới nhất của quy trình. Không áp dụng bộ lọc hàng. Kết quả được chia trang: dùng limit (mặc định 1000, tối đa 10000) và offset, tiếp tục lấy trang khi hasMore là true. Trong khi hệ thống vẫn đang tính chỉ số, phản hồi có trạng thái preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
limit integer truy vấn Không Số hàng case tối đa cần trả về (mặc định 1000, tối đa 10000)
offset integer truy vấn Không Số hàng case cần bỏ qua (mặc định 0)

Phản hồi (200):

Chỉ số case

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên
  • 503 Đường ống dữ liệu chưa sẵn sàng hoặc truy vấn ở hệ thống nguồn gặp lỗi

Liệt kê các phiên bản quy trình

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
limit integer truy vấn Không Số mục tối đa cần trả về
offset integer truy vấn Không Số mục cần bỏ qua

Phản hồi (200):

Danh sách phiên bản

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Tạo ảnh chụp phiên bản của quy trình

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
displayName string Không Nhãn phiên bản
Mặc định: ""
Độ dài tối đa: 128
description string Không Mô tả tùy chọn về phiên bản
versionType manual | auto Không thủ công = do người dùng tạo, tự động = do hệ thống tạo
Giá trị được phép: manual, auto
restoreFromVersionId string Không Phiên bản dùng để khôi phục khi tạo ảnh chụp này
Định dạng: uuid

Phản hồi (201):

Đã tạo phiên bản

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
Trường Kiểu Bắt buộc Mô tả
version object Có
restoredFrom object Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Lấy phiên bản quy trình

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
versionId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Phiên bản

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
Trường Kiểu Bắt buộc Mô tả
version object Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Đổi tên hoặc cập nhật phiên bản quy trình

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
versionId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"description": "string"
}
Trường Kiểu Bắt buộc Mô tả
displayName string Không Nhãn phiên bản
Độ dài tối đa: 128
description string Không Mô tả tùy chọn về phiên bản

Phản hồi (200):

Phiên bản đã cập nhật

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
Trường Kiểu Bắt buộc Mô tả
version object Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Xóa phiên bản quy trình

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
versionId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Đã xóa phiên bản

{
	"deleted": true
}
Trường Kiểu Bắt buộc Mô tả
deleted boolean Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Lấy tài nguyên

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
artifactId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Tài nguyên

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
displayName string Có Mặc định: ""
Độ dài tối đa: 500
description string Có Độ dài tối đa: 2000
originalFileName string Có Mặc định: ""
Độ dài tối đa: 500
mimeType string Có Mặc định: ""
Độ dài tối đa: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Có Giá trị cho phép: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Có Giá trị cho phép: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Mặc định: modelIcon
uploadState Uploading | Ready | Failed | Deleted Có Giá trị cho phép: Uploading, Ready, Failed, Deleted
Mặc định: Uploading
hasThumbnail boolean Có Mặc định: false
sizeBytes number Có Mặc định: 0
createdAt string Có Định dạng: date-time
createdBy string Không Định dạng: uuid

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Cập nhật tên hiển thị hoặc mô tả của tài nguyên

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
artifactId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"displayName": "string",
	"description": "string"
}
Trường Kiểu Bắt buộc Mô tả
displayName string Không Tên tài nguyên
Độ dài tối đa: 500
description string Không Mô tả tùy chọn về tài nguyên
Độ dài tối đa: 2000

Phản hồi (200):

Tài nguyên đã cập nhật

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
Trường Kiểu Bắt buộc Mô tả
id string Có Định dạng: uuid
displayName string Có Mặc định: ""
Độ dài tối đa: 500
description string Có Độ dài tối đa: 2000
originalFileName string Có Mặc định: ""
Độ dài tối đa: 500
mimeType string Có Mặc định: ""
Độ dài tối đa: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Có Giá trị cho phép: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Có Giá trị cho phép: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Mặc định: modelIcon
uploadState Uploading | Ready | Failed | Deleted Có Giá trị cho phép: Uploading, Ready, Failed, Deleted
Mặc định: Uploading
hasThumbnail boolean Có Mặc định: false
sizeBytes number Có Mặc định: 0
createdAt string Có Định dạng: date-time
createdBy string Không Định dạng: uuid

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Xóa tài nguyên

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
artifactId string đường dẫn Có Định dạng: uuid

Phản hồi (200):

Đã xóa tài nguyên

{
	"deleted": true
}
Trường Kiểu Bắt buộc Mô tả
deleted boolean Có

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Chuyển hướng đến URL có chữ ký sẵn để tải tài nguyên xuống

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
artifactId string đường dẫn Có Định dạng: uuid

Lỗi:

  • 302 Chuyển hướng đến URL tải xuống có chữ ký sẵn
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Liệt kê tài nguyên đính kèm với quy trình

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid
limit integer truy vấn Không Số mục tối đa cần trả về
offset integer truy vấn Không Số mục cần bỏ qua

Phản hồi (200):

Danh sách tài nguyên của quy trình

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Lỗi:

  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 404 Không tìm thấy tài nguyên

Lấy URL tải lên S3 có chữ ký sẵn cho tài nguyên quy trình mới

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên Kiểu Vị trí Bắt buộc Mô tả
tenantId string đường dẫn Có Định dạng: uuid
processId string đường dẫn Có Định dạng: uuid

Nội dung yêu cầu:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
Trường Kiểu Bắt buộc Mô tả
fileName string Có
mimeType string Có
sizeBytes number Có
artifactType modelIcon | processArtifact | doc | levelFrontPageImage Không Giá trị cho phép: modelIcon, processArtifact, doc, levelFrontPageImage
Mặc định: processArtifact

Phản hồi (200):

URL tải lên có chữ ký sẵn

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
Trường Kiểu Bắt buộc Mô tả
artifactId string Có Định dạng: uuid
originalUrl string Có
thumbnailUrl string Có

Lỗi:

  • 400 Yêu cầu không hợp lệ: ví dụ biểu thức bộ lọc không hợp lệ, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
  • 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
  • 403 API key không có phạm vi hoặc quyền truy cập tổ chức cần thiết, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
  • 404 Không tìm thấy tài nguyên
  • 409 Yêu cầu xung đột với trạng thái hiện tại (ví dụ: giới hạn giấy phép hoặc ID đã được dùng)

Tài liệu liên quan

Thiết kế quy trình tốt hơn. Kết nối các quy trình. Luôn chủ động kiểm soát.

Truy cập ngay, không cần thẻ tín dụng hay chờ đợi. Biến cách tổ chức của bạn vận hành thành các thiết kế quy trình rõ ràng, liên kết với nhau.

Xây dựng kiến trúc quy trình, xác định quyền sở hữu và cơ chế kiểm soát, đồng thời thống nhất vai trò và trách nhiệm ở mọi cấp.

Bắt đầu dùng thử miễn phí để tạo nền tảng đáng tin cậy cho việc quản trị, quản lý và cải tiến quy trình liên tục.

Dùng thử miễn phí ngay