Trong trang này

> tai nguyen > tai lieu > api > Tài liệu tham khảo API: Mô phỏng

Tài liệu tham khảo API: Mô phỏng

Mô phỏng giúp bạn chạy các kịch bản giả định trên mô hình quy trình. Bạn có thể cấu hình thời gian xử lý, phân bổ tài nguyên và tốc độ phát sinh để dự đoán cách quy trình sẽ vận hành.

Liệt kê mô phỏng của một quy trình

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

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 mô phỏng

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"datasetName": "string",
		"startTime": "2024-03-15T16:30:00Z",
		"endTime": "2024-03-15T16:30:00Z",
		"useWarmUp": true
	}
]

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

Tạo mô phỏng (có tính lặp an toàn nếu cung cấp ID)

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

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:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Không	ID tùy chọn để thử lại mà không tạo bản trùng (phải là UUID) Định dạng: `uuid`
displayName	string	Không	Tên mô phỏng Mặc định: `New Simulation`
datasetName	string	Không	Tên bộ dữ liệu dùng để chạy mô phỏng
startTime	string	Không	Thời điểm bắt đầu mô phỏng Định dạng: `date-time`
endTime	string	Không	Thời điểm kết thúc mô phỏng Định dạng: `date-time`
useWarmUp	boolean	Không	Có loại bỏ giai đoạn khởi động hay không Mặc định: `false`

Phản hồi (201):

Đã tạo mô phỏng

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
simulation	object	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
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)

Lấy mô phỏng cùng cấu hình phần tử, thuộc tính và tài nguyên

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

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`
simulationId	string	đường dẫn	Có	Định dạng: `uuid`

Phản hồi (200):

Chi tiết mô phỏng

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"datasetName": "string",
		"startTime": "2024-03-15T16:30:00Z",
		"endTime": "2024-03-15T16:30:00Z",
		"useWarmUp": true
	},
	"elementSettings": [
		{
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"modelElementId": "00000000-0000-0000-0000-000000000000",
			"settings": {
				"processingTimeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"processingTimeUnit": "seconds",
				"updateAttributeRules": [
					{
						"id": "string",
						"attributeId": "00000000-0000-0000-0000-000000000000",
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"newValue": "string",
						"isEnabled": true
					}
				],
				"requiredResources": [
					{
						"resourceId": "00000000-0000-0000-0000-000000000000",
						"amount": 0
					}
				],
				"caseStartsDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"caseStartsTimeUnit": "perTimeSlot",
				"capacityInterval": "perHour",
				"skipChanceDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"queueStrategy": "fifo",
				"chanceToTakeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				]
			}
		}
	],
	"attributes": [
		{
			"id": "00000000-0000-0000-0000-000000000000",
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"valueDistribution": {
				"type": "Number",
				"numberDistributions": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot",
						"id": "string",
						"isEnabled": true,
						"isDefault": true
					}
				],
				"textDistributions": [
					{
						"id": "string",
						"timeslot": {
							"periodicity": "Always"
						},
						"isEnabled": true,
						"isDefault": true,
						"mode": "list",
						"textValues": [
							{
								"id": "string",
								"value": "string",
								"chance": 0
							}
						]
					}
				]
			},
			"simulationAttributeType": "string"
		}
	],
	"resources": [
		{
			"id": "00000000-0000-0000-0000-000000000000",
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"levelDistribution": [
				{
					"timeslot": {
						"periodicity": "Always"
					},
					"conditions": [
						{
							"type": "Values",
							"attribute": "string",
							"values": [
								"string"
							]
						}
					],
					"distribution": {
						"type": "Fixed",
						"value": 0
					},
					"timeUnit": "seconds",
					"rateUnit": "perTimeSlot"
				}
			],
			"attributeId": "00000000-0000-0000-0000-000000000000"
		}
	]
}

Trường	Kiểu	Bắt buộc	Mô tả
simulation	object	Có	Thông tin chung về mô phỏng
elementSettings	object[]	Có	Cấu hình mô phỏng cho từng phần tử
attributes	object[]	Có	Các thuộc tính được mô phỏng
resources	object[]	Có	Các nhóm tài nguyên

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ập nhật mô phỏng (các trường và/hoặc cấu hình phần tử)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

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`
simulationId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true,
	"elementSettings": [
		{
			"modelElementId": "00000000-0000-0000-0000-000000000000",
			"settings": {
				"caseStartsDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"processingTimeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				]
			}
		}
	]
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Không	Tên mô phỏng
datasetName	string	Không	Tên bộ dữ liệu dùng để chạy mô phỏng
startTime	string	Không	Thời điểm bắt đầu mô phỏng Định dạng: `date-time`
endTime	string	Không	Thời điểm kết thúc mô phỏng Định dạng: `date-time`
useWarmUp	boolean	Không	Có loại bỏ giai đoạn khởi động hay không
elementSettings	object[]	Không	Ghi đè cài đặt cho từng phần tử

Phản hồi (200):

Đã cập nhật mô phỏng

{
	"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 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ệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Xóa hẳn mô phỏng

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

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`
simulationId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Đã xóa mô phỏng

{
	"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 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ệ, đã 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 cài đặt mô phỏng dựa trên mô hình quy trình.

Tạo cài đặt mô phỏng bằng AI (xử lý bất đồng bộ, kiểm tra endpoint trạng thái)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings

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 liên tiếp)

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`
simulationId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"processDescription": "string",
	"additionalContext": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
processDescription	string	Không
additionalContext	string	Không

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:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ 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ệ, đã 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 cài đặt mô phỏng

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings/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	path	Có	Định dạng: `uuid`
processId	string	path	Có	Định dạng: `uuid`
simulationId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Trạng thái tạo

{
	"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 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ệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Bắt đầu chạy mô phỏng (xử lý bất đồng bộ, kết quả được lưu vào các bảng dữ liệu của quy trình)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run

Xác thực: API key giới hạn theo tenant · phạm vi write · giới hạn tốc độ 5 yêu cầu/giây (tối đa 10 yêu cầu liên tiếp)

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`
simulationId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Đã bắt đầu mô phỏng

{
	"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 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ệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Lấy trạng thái lần chạy mô phỏng gần nhất (dựa trên bảng dữ liệu đầu ra)

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run/status

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`
simulationId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Trạng thái lần chạy

{
	"state": "notStarted",
	"startedAt": "2024-03-15T16:30:00Z",
	"completedAt": "2024-03-15T16:30:00Z",
	"step": "string",
	"casesSimulated": 0,
	"targetCases": 0,
	"eventsGenerated": 0,
	"errorMessage": "string",
	"simulationId": "00000000-0000-0000-0000-000000000000"
}

Trường	Kiểu	Bắt buộc	Mô tả
state	`notStarted` \| `running` \| `processing` \| `ready` \| `error`	Có	Giá trị được phép: `notStarted`, `running`, `processing`, `ready`, `error`
startedAt	string	Không	Định dạng: `date-time`
completedAt	string	Không	Định dạng: `date-time`
step	string	Không
casesSimulated	number	Không
targetCases	number	Không
eventsGenerated	number	Không
errorMessage	string	Không
simulationId	string	Có	Định dạng: `uuid`

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ 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ệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Tài liệu liên quan

Tài liệu tham khảo API: tổ chức

Tài liệu API cho các điểm cuối quản lý tổ chức và người dùng.

Tài liệu tham khảo API: Tenant

Tài liệu tham khảo API cho các endpoint quản lý tenant và kiểm soát quyền truy cập của người dùng.

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

Tài liệu API cho các endpoint quản lý dataset và datatable.

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

Tài liệu API cho các điểm cuối quản lý quy trình và ánh xạ dữ liệu.

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