Tài liệu API: Dữ liệu

Cách dùng:

# Get the presigned URL with required parameters
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{datatableId}/uploads/presigned-url?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

Cách dùng:

# Get the download URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/download")

# Extract URL and download the file
DOWNLOAD_URL=$(echo $RESPONSE | jq -r '.downloadUrl')
curl -o "data.csv" "$DOWNLOAD_URL"

Cách dùng:

# Get delta presigned URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url?delta=true&filename=delta.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the delta file
UPLOAD_URL=$(echo $RESPONSE | jq -r '.PreSignedUploadUrl')
curl -X PUT --upload-file "delta.csv" -H "Content-Type: text/csv" "$UPLOAD_URL"

Dataset là tập hợp các datatable có liên quan và được nhóm chung theo logic.

Liệt kê dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets

Xác thực: API key theo tenant · phạm vi quyền 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

Response (200):

Danh sách dataset

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Dataset",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"dataTableId": "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 dataset (kèm datatable trống)

Endpoint: POST /v1/tenant/{tenantId}/datasets

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset"
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Có	Tên bộ dữ liệu hiển thị trong cây dữ liệu Độ 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	Dataset | TreeGroup	Không	Bộ dữ liệu hoặc thư mục Giá trị cho phép: Dataset, TreeGroup Mặc định: Dataset

Response (201):

Dataset đã tạo

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "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	Dataset | TreeGroup	Có	Giá trị được phép: Dataset, TreeGroup Mặc định: Dataset
displayName	string	Có	Mặc định: "" Độ dài tối đa: 128
createdAt	string	Có	Định dạng: date-time
updatedAt	string	Có	Định dạng: date-time
dataTableId	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

Lấy thông tin dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}

Xác thực: API key theo tenant · phạm vi quyền read

Tham số:

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

Response (200):

Dataset

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "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	Dataset | TreeGroup	Có	Giá trị được phép: Dataset, TreeGroup Mặc định: Dataset
displayName	string	Có	Mặc định: "" Độ dài tối đa: 128
createdAt	string	Có	Định dạng: date-time
updatedAt	string	Có	Định dạng: date-time
dataTableId	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

Xóa mềm dataset

Endpoint: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Response (200):

Dataset đã xóa

{
	"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

Liệt kê datatable trong dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Xác thực: API key theo tenant · phạm vi quyền read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: uuid
datasetId	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

Response (200):

Danh sách datatable trong dataset

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

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

Tạo datatable trống trong dataset

Endpoint: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"displayName": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Có	Tên datatable Độ dài tối đa: 128

Response (201):

Đã tạo datatable

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: uuid
datasetId	string	Có	Định dạng: uuid
displayName	string	Có	Mặc định: "" Độ dài tối đa: 128
createdAt	string	Có	Định dạng: date-time
updatedAt	string	Có	Định dạng: date-time
hasDataLoaded	boolean	Có	Mặc định: false
filterExpression	string	Có	Độ dài tối đa: 4096
metaInfo	object | object | object | object	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

Datatable lưu dữ liệu nhật ký sự kiện dùng cho process mining.

Liệt kê datatable

Endpoint: GET /v1/tenant/{tenantId}/datatables

Xác thực: API key theo tenant · phạm vi quyền 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

Response (200):

Danh sách datatable

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

Lỗi:

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

Lấy thông tin datatable

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Xác thực: API key theo tenant · phạm vi quyền read

Tham số:

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

Response (200):

Datatable

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: uuid
datasetId	string	Có	Định dạng: uuid
displayName	string	Có	Mặc định: "" Độ dài tối đa: 128
createdAt	string	Có	Định dạng: date-time
updatedAt	string	Có	Định dạng: date-time
hasDataLoaded	boolean	Có	Mặc định: false
filterExpression	string	Có	Độ dài tối đa: 4096
metaInfo	object | object | object | object	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

Cập nhật datatable (displayName, parseSettings, …)

Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"displayName": "string",
	"filterExpression": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Không	Tên datatable Độ dài tối đa: 128
filterExpression	string	Không	Biểu thức lọc áp dụng cho dữ liệu Độ dài tối đa: 4096

Response (200):

Đã cập nhật datatable

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: uuid
datasetId	string	Có	Định dạng: uuid
displayName	string	Có	Mặc định: "" Độ dài tối đa: 128
createdAt	string	Có	Định dạng: date-time
updatedAt	string	Có	Định dạng: date-time
hasDataLoaded	boolean	Có	Mặc định: false
filterExpression	string	Có	Độ dài tối đa: 4096
metaInfo	object | object | object | object	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

Lấy URL có chữ ký trước để tải tệp nguồn của datatable

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Xác thực: API key theo tenant · phạm vi quyền read

Tham số:

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

Response (200):

URL tải xuống

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}

Trường	Kiểu	Bắt buộc	Mô tả
downloadUrl	string	Có
expiresInSeconds	number	Có

Lỗi:

• 400 Request không hợp lệ: ví dụ, biểu thức lọc sai, 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

Hủy tải lên nhiều phần và loại bỏ các phần đã tải lên

API key cần có phạm vi quyền uploadData.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"uploadId": "string",
	"uploadHandle": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
uploadId	string	Có
uploadHandle	string	Có	Mã định danh không thể đọc được, trả về ở bước khởi tạo

Response (200):

Đã hủy

{
	"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ệ, bị vô hiệu hóa hoặc hết hạn API key
• 403 API key không có phạm vi quyền 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

Hoàn tất tải lên nhiều phần (bước 3/3)

API key cần có phạm vi quyền uploadData. Thao tác này ghép các phần đã tải lên (dựa trên ETag) và bắt đầu xử lý nhật ký sự kiện.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}

Trường	Kiểu	Bắt buộc	Mô tả
uploadId	string	Có
uploadHandle	string	Có	Mã định danh không thể đọc được, trả về ở bước khởi tạo
parts	object[]	Có

Response (200):

Đã hoàn tất ({ completed: true })

{
	"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ệ, bị vô hiệu hóa hoặc hết hạn API key
• 403 API key không có phạm vi quyền 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

Bắt đầu tải nhật ký sự kiện theo nhiều phần (chia khối, bước 1/3)

API key cần có phạm vi quyền uploadData. Endpoint trả về một uploadId và một uploadHandle không thể đọc được để gửi trong các request parts, complete và abort tiếp theo. Phù hợp với tệp lớn.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}

Trường	Kiểu	Bắt buộc	Mô tả
fileName	string	Có
fileSize	number	Có
fileLastModified	number	Có
partCount	number	Không	Số phần cần tạo URL có chữ ký trước (mặc định 10)
delta	boolean	Không	Có phải là lượt tải lên phần dữ liệu bổ sung (tăng dần) hay không
datasetId	string	Không	Định dạng: uuid
modelId	string	Không	Định dạng: uuid

Response (200):

Đã khởi tạo lượt tải lên

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}

Trường	Kiểu	Bắt buộc	Mô tả
uploadId	string	Không
uploadHandle	string	Không	Mã định danh không thể đọc được, dùng cho các bước tải phần, hoàn tất và hủy
partCount	number	Không
partSizeBytes	number	Không

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 quyền 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

Lấy URL có chữ ký trước cho từng phần tải lên (bước 2/3)

API key cần có phạm vi quyền uploadData. Endpoint trả về một URL PUT có chữ ký trước cho mỗi số thứ tự phần được yêu cầu.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

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

Request body:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}

Trường	Kiểu	Bắt buộc	Mô tả
uploadId	string	Có
uploadHandle	string	Có	Mã định danh không thể đọc được, trả về ở bước khởi tạo
partNumbers	number[]	Có

Response (200):

URL có chữ ký trước cho từng phần ({ uploadId, parts: [{ partNumber, url }] })

{
	"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ệ, bị vô hiệu hóa hoặc hết hạn API key
• 403 API key không có phạm vi quyền 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

Lấy URL tải lên S3 có chữ ký trước cho nhật ký sự kiện (CSV/XLSX, toàn bộ hoặc phần bổ sung)

API key cần có phạm vi quyền uploadData (không phụ thuộc read/write). Giá trị filesize đã khai báo (tính bằng byte) được kiểm tra với giới hạn kích thước tải lên tối đa của nền tảng. Kích thước thực tế của tệp sẽ được kiểm tra lại khi tệp được tải lên.

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Xác thực: API key theo tenant · phạm vi quyền read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: uuid
dataTableId	string	path	Có	Định dạng: uuid
filename	string	query	Có
filesize	string	query	Có	Kích thước tệp tính bằng byte (được kiểm tra với giới hạn kích thước tải lên tối đa của nền tảng)
filelastmodified	string	query	Có
datasetid	string	query	Không	Bắt buộc khi tải lên toàn bộ (không phải phần bổ sung)
modelid	string	query	Không	Định dạng: uuid
delta	true | false	query	Không	Giá trị được phép: true, false
partnumber	string	query	Không
validforseconds	integer	query	Không	Thời hạn URL có chữ ký trước, tính bằng giây (1–3600, mặc định 3600)

Response (200):

URL có chữ ký trước

{
	"PreSignedUploadUrl": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
PreSignedUploadUrl	string	Có	URL PUT S3 có chữ ký trước (có hiệu lực khoảng 1 giờ)

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 quyền 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
• 413 Tệp vượt quá giới hạn kích thước tải lên tối đa của nền tảng