Bu sayfada
> kaynaklar > belgeler > api > API referansı: Simülasyonlar

API referansı: Simülasyonlar

Simülasyonlar, süreç modelleriniz üzerinde what-if senaryoları çalıştırmanızı sağlar. Süreç davranışını öngörmek için işlem sürelerini, kaynak dağılımlarını ve geliş oranlarını yapılandırabilirsiniz.

Bir sürecin simülasyonlarını listeleyin

Uç nokta: GET /v1/tenant/{tenantId}/processes/{processId}/simulations

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
limit integer query Hayır Döndürülecek en fazla öğe sayısı
offset integer query Hayır Atlanacak öğe sayısı

Yanıt (200):

Simülasyon listesi

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

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Simülasyon oluşturun (kimlik verildiğinde işlem yinelense de sonuç değişmez)

Uç nokta: POST /v1/tenant/{tenantId}/processes/{processId}/simulations

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid

İstek gövdesi:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}
Alan Tür Zorunlu Açıklama
id string Hayır Yinelenen isteklerde kullanılacak isteğe bağlı kimlik (UUID olmalıdır)
Biçim: uuid
displayName string Hayır Simülasyon adı
Varsayılan: New Simulation
datasetName string Hayır Simülasyonun çalıştırılacağı veri setinin adı
startTime string Hayır Simülasyon başlangıç zamanı
Biçim: date-time
endTime string Hayır Simülasyon bitiş zamanı
Biçim: date-time
useWarmUp boolean Hayır Isınma döneminin hariç tutulup tutulmayacağı
Varsayılan: false

Yanıt (201):

Simülasyon oluşturuldu

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}
Alan Tür Zorunlu Açıklama
simulation object Evet
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı
  • 409 İstek mevcut durumla çakışıyor (ör. kullanıcı lisansı kısıtlaması veya yeniden kullanılan bir kimlik)

Öğe ayarları, öznitelikleri ve kaynaklarıyla birlikte bir simülasyon alın

Uç nokta: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

Yanıt (200):

Simülasyon ayrıntıları

{
	"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"
		}
	]
}
Alan Tür Zorunlu Açıklama
simulation object Evet Simülasyon üst bilgisi
elementSettings object[] Evet Öğe başına simülasyon ayarları
attributes object[] Evet Simüle edilen öznitelikler
resources object[] Evet Kaynak havuzları

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Simülasyonu güncelleyin (alanları ve/veya öğe ayarlarını)

Uç nokta: PUT /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

İstek gövdesi:

{
	"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"
					}
				]
			}
		}
	]
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Simülasyon adı
datasetName string Hayır Simülasyonun çalıştırılacağı veri setinin adı
startTime string Hayır Simülasyon başlangıç zamanı
Biçim: date-time
endTime string Hayır Simülasyon bitiş zamanı
Biçim: date-time
useWarmUp boolean Hayır Isınma döneminin hariç tutulup tutulmayacağı
elementSettings object[] Hayır Öğe başına ayar geçersiz kılmaları

Yanıt (200):

Simülasyon güncellendi

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Simülasyonu kalıcı olarak silin

Uç nokta: DELETE /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

Yanıt (200):

Simülasyon silindi

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bu uç noktalar, süreç modeline göre simülasyon ayarlarını otomatik olarak oluşturmak için yapay zekâ kullanır.

Simülasyon ayarlarını yapay zekâ ile oluşturun (eşzamansız; durum uç noktasını düzenli aralıklarla sorgulayın)

Uç nokta: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı · istek sınırı: saniyede 2 istek (ani artışta 4)

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

İstek gövdesi:

{
	"processDescription": "string",
	"additionalContext": "string"
}
Alan Tür Zorunlu Açıklama
processDescription string Hayır
additionalContext string Hayır

Yanıt (200):

Oluşturma başladı / sonuç

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Simülasyon ayarlarının oluşturulma durumunu sorgulayın

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

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

Yanıt (200):

Oluşturma durumu

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Simülasyonu çalıştırın (eşzamansız; sonuçlar sürecin veri tablolarına yazılır)

Uç nokta: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı · istek sınırı: saniyede 5 istek (ani artışta 10)

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

Yanıt (200):

Simülasyon başlatıldı

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Son simülasyon çalıştırmasının durumunu alın (çıktı veri tablosundan belirlenir)

Uç nokta: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run/status

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
processId string path Evet Biçim: uuid
simulationId string path Evet Biçim: uuid

Yanıt (200):

Çalıştırma durumu

{
	"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"
}
Alan Tür Zorunlu Açıklama
state notStarted | running | processing | ready | error Evet İzin verilen değerler: notStarted, running, processing, ready, error
startedAt string Hayır Biçim: date-time
completedAt string Hayır Biçim: date-time
step string Hayır
casesSimulated number Hayır
targetCases number Hayır
eventsGenerated number Hayır
errorMessage string Hayır
simulationId string Evet Biçim: uuid

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

İlgili dokümantasyon