Di halaman ini
> sumber daya > dokumentasi > api > Referensi API: Simulasi

Referensi API: Simulasi

Simulasi memungkinkan Anda menguji berbagai skenario pada model proses. Atur waktu pemrosesan, alokasi sumber daya, dan tingkat kedatangan untuk memperkirakan perilaku proses.

Daftar simulasi untuk suatu proses

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
limit integer query Tidak Jumlah maksimum item yang dikembalikan
offset integer query Tidak Jumlah item yang dilewati

Respons (200):

Daftar simulasi

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

Kesalahan:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
  • 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404Sumber daya tidak ditemukan

Buat simulasi (idempotent jika ID disertakan)

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid

Isi permintaan:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}
Kolom Tipe Wajib Deskripsi
id string Tidak ID opsional untuk percobaan ulang idempotent (harus berupa UUID)
Format: uuid
displayName string Tidak Nama simulasi
Default: New Simulation
datasetName string Tidak Nama dataset yang digunakan untuk menjalankan simulasi
startTime string Tidak Waktu mulai simulasi
Format: date-time
endTime string Tidak Waktu selesai simulasi
Format: date-time
useWarmUp boolean Tidak Apakah periode pemanasan akan diabaikan
Default: false

Respons (201):

Simulasi dibuat

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}
Kolom Tipe Wajib Deskripsi
simulation object Ya
message string Ya

Kesalahan:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
  • 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404Sumber daya tidak ditemukan
  • 409Permintaan bertentangan dengan status saat ini (misalnya, batas lisensi atau ID yang digunakan kembali)

Ambil simulasi beserta pengaturan elemen, atribut, dan sumber dayanya

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Respons (200):

Detail simulasi

{
	"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"
		}
	]
}
Kolom Tipe Wajib Deskripsi
simulation object Ya Ringkasan simulasi
elementSettings object[] Ya Pengaturan simulasi untuk setiap elemen
attributes object[] Ya Atribut yang disimulasikan
resources object[] Ya Kumpulan sumber daya

Kesalahan:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
  • 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404Sumber daya tidak ditemukan

Perbarui simulasi (kolom dan/atau pengaturan elemen)

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Isi permintaan:

{
	"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"
					}
				]
			}
		}
	]
}
Field Tipe Wajib Deskripsi
displayName string Tidak Nama simulasi
datasetName string Tidak Nama dataset yang digunakan untuk menjalankan simulasi
startTime string Tidak Waktu mulai simulasi
Format: date-time
endTime string Tidak Waktu selesai simulasi
Format: date-time
useWarmUp boolean Tidak Apakah periode pemanasan akan diabaikan
elementSettings object[] Tidak Pengaturan pengganti untuk tiap elemen

Respons (200):

Simulasi diperbarui

{
	"message": "string"
}
Field Tipe Wajib Deskripsi
message string Ya

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Hapus simulasi secara permanen

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Respons (200):

Simulasi dihapus

{
	"message": "string"
}
Field Tipe Wajib Deskripsi
message string Ya

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Endpoint ini menggunakan AI untuk membuat pengaturan simulasi secara otomatis berdasarkan model proses.

Buat pengaturan simulasi dengan AI (asinkron; periksa status melalui endpoint status)

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

Autentikasi: API key khusus tenant · cakupan write · batas laju 2 permintaan/detik (lonjakan hingga 4)

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Isi permintaan:

{
	"processDescription": "string",
	"additionalContext": "string"
}
Field Tipe Wajib Deskripsi
processDescription string Tidak
additionalContext string Tidak

Respons (200):

Pembuatan dimulai / hasil

{
	"message": "string"
}
Field Tipe Wajib Deskripsi
message string Ya

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Periksa status pembuatan pengaturan simulasi

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Respons (200):

Status pembuatan

{
	"message": "string"
}
Field Tipe Wajib Deskripsi
message string Ya

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Mulai jalankan simulasi (asinkron; hasil tersimpan di tabel data proses)

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

Autentikasi: API key khusus tenant · cakupan write · batas laju 5 permintaan/detik (lonjakan hingga 10)

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Respons (200):

Simulasi dimulai

{
	"message": "string"
}
Field Tipe Wajib Deskripsi
message string Ya

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Lihat status simulasi terakhir (diambil dari tabel data keluaran)

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid
processId string path Ya Format: uuid
simulationId string path Ya Format: uuid

Respons (200):

Status proses

{
	"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"
}
Field Tipe Wajib Deskripsi
state notStarted | running | processing | ready | error Ya Nilai yang diizinkan: notStarted, running, processing, ready, error
startedAt string Tidak Format: date-time
completedAt string Tidak Format: date-time
step string Tidak
casesSimulated number Tidak
targetCases number Tidak
eventsGenerated number Tidak
errorMessage string Tidak
simulationId string Ya Format: uuid

Error:

  • 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau field wajib yang tidak diisi
  • 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 404 Sumber daya tidak ditemukan

Dokumentasi terkait

Rancang proses yang lebih baik. Bangun arsitektur yang saling terhubung. Tetap kendalikan semuanya.

Mulai sekarang juga tanpa kartu kredit dan tanpa perlu menunggu. Ubah cara kerja organisasi Anda menjadi rancangan proses yang jelas dan saling terhubung.

Bangun arsitektur proses, tetapkan penanggung jawab dan kontrol, lalu selaraskan peran serta tanggung jawab di setiap tingkat.

Mulai uji coba gratis dan bangun satu landasan tepercaya untuk mengatur, mengelola, dan terus memperbaiki proses Anda.

Mulai uji coba gratis hari ini