Bu sayfada
> kaynaklar > belgeler > api > API referansı: Süreçler

API referansı: Süreçler

Süreçleri listeleyin

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

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

Parametreler:

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

Yanıt (200):

Süreç listesi

[
	{
		"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"
	}
]

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı

Bir süreç oluşturun (boş bir modelle)

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

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
Alan Tür Gerekli Açıklama
displayName string Evet Süreç ağacında gösterilen süreç adı
Maksimum uzunluk: 128
treeParentId string Hayır Üst klasör kimliği (null = üst düzey)
Biçim: uuid
treeNodeType Process | TreeGroup Hayır Süreç veya TreeGroup (klasör)
İzin verilen değerler: Process, TreeGroup
Varsayılan: Process

Yanıt (201):

Süreç oluşturuldu

{
	"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"
}
Alan Tür Gerekli Açıklama
id string Evet Biçim: uuid
treeParentId string Evet Biçim: uuid
treeNodeType Process | TreeGroup Evet İzin verilen değerler: Process, TreeGroup
Varsayılan: Process
displayName string Evet Varsayılan: New Process
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
designerModelId string Evet Biçim: uuid

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 500 Beklenmeyen sunucu hatası: istek güvenle yeniden denenebilir

Bir süreci alın

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

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

Parametreler:

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

Yanıt (200):

Süreç

{
	"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"
}
Alan Tür Gerekli Açıklama
id string Evet Biçim: uuid
treeParentId string Evet Biçim: uuid
treeNodeType Process | TreeGroup Evet İzin verilen değerler: Process, TreeGroup
Varsayılan: Process
displayName string Evet Varsayılan: New Process
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
designerModelId string Evet Biçim: uuid

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir süreci güncelleyin

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

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
Alan Tür Gerekli Açıklama
displayName string Hayır Süreç ağacında gösterilen süreç adı
Maksimum uzunluk: 128
treeParentId string Hayır Üst klasör kimliği (null = üst düzey)
Biçim: uuid

Yanıt (200):

Süreç güncellendi

{
	"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"
}
Alan Tür Gerekli Açıklama
id string Evet Biçim: uuid
treeParentId string Evet Biçim: uuid
treeNodeType Process | TreeGroup Evet İzin verilen değerler: Process, TreeGroup
Varsayılan: Process
displayName string Evet Varsayılan: New Process
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
designerModelId string Evet Biçim: uuid

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı
  • 500 Beklenmeyen sunucu hatası: istek güvenle yeniden denenebilir

Bir süreci geçici olarak silin

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

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

Parametreler:

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

Yanıt (200):

Süreç silindi

{
	"success": true,
	"message": "string"
}
Alan Tür Gerekli Açıklama
success boolean Evet
message string Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Süreç modelini BPMN 2.0 XML olarak dışa aktarın

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

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

Parametreler:

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

Yanıt (200):

BPMN XML

{
	"bpmnXml": "string"
}
Alan Tür Gerekli Açıklama
bpmnXml string Evet BPMN 2.0 XML

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı
  • 500 Beklenmeyen sunucu hatası: istek güvenle yeniden denenebilir

Süreç için BPMN 2.0 modeli içe aktarın (mevcut modelin yerini alır)

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

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

Parametreler:

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

İstek gövdesi:

{
	"bpmnXml": "string"
}
Alan Tür Gerekli Açıklama
bpmnXml string Evet BPMN 2.0 XML

Yanıt (200):

BPMN yüklendi

{
	"message": "string"
}
Alan Tür Gerekli 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ı

Veri haritalamaları, veri tablolarını süreçlere bağlayarak Event Log verilerinizi süreç modeli üzerinde görselleştirmenizi ve analiz etmenizi sağlar.

Bir sürecin veri haritalamalarını listeleyin

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

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

Parametreler:

Ad Tür Konum Gerekli 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 maksimum öğe sayısı
offset integer query Hayır Atlanacak öğe sayısı

Yanıt (200):

Haritalama listesi

[
	{
		"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
	}
]

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ı

Bir veri tablosunu sürece eşleyin (Event Log işlenmeye başlar)

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

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

Parametreler:

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

İstek gövdesi:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
Alan Tür Zorunlu Açıklama
dataTableId string Evet Sürece eşlenecek Veri Seti
Biçim: uuid
displayName string Hayır Haritalama görünen adı
Maksimum uzunluk: 128
color object Hayır Vurgu rengi
showByDefault boolean Hayır Süreç görünümünde bu haritalamayı varsayılan olarak gösterir
Varsayılan: true
mappingRole primary | comparison Hayır Eşlenen verinin modeldeki rolü
İzin verilen değerler: primary, comparison

Yanıt (201):

Haritalama oluşturuldu

{
	"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
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
modelId string Evet Biçim: uuid
dataTableId string Evet Biçim: uuid
displayName string Evet Maksimum uzunluk: 128
color object Evet
showByDefault boolean Evet Varsayılan: true
mappingRole primary | comparison Evet İzin verilen değerler: primary, comparison
Varsayılan: comparison
sortOrder integer Evet Varsayılan: 0
Minimum: -9007199254740991
Maksimum: 9007199254740991

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ı

Bir haritalamayı güncelleyin

Uç nokta: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Maksimum uzunluk: 128
color object Hayır
showByDefault boolean Hayır
mappingRole primary | comparison Hayır İzin verilen değerler: primary, comparison
sortOrder integer Hayır Minimum: -9007199254740991
Maksimum: 9007199254740991

Yanıt (200):

Haritalama güncellendi

{
	"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
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
modelId string Evet Biçim: uuid
dataTableId string Evet Biçim: uuid
displayName string Evet Maksimum uzunluk: 128
color object Evet
showByDefault boolean Evet Varsayılan: true
mappingRole primary | comparison Evet İzin verilen değerler: primary, comparison
Varsayılan: comparison
sortOrder integer Evet Varsayılan: 0
Minimum: -9007199254740991
Maksimum: 9007199254740991

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ı

Bir haritalamayı silin

Uç nokta: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

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

Parametreler:

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

Yanıt (200):

Haritalama silindi

{
	"success": true,
	"message": "string"
}
Alan Tür Zorunlu Açıklama
success boolean 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ı

Bu uç noktalar, doğal dil açıklamalarından BPMN süreç modellerini otomatik olarak oluşturmak için yapay zekâ kullanır.

Doğal dil isteminden süreç modeli oluşturun (eşzamansız, durum uç noktasını sorgulayın)

Uç nokta: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

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

Parametreler:

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

İstek gövdesi:

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

Yanıt (200):

Oluşturma başlatıldı / sonuç

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

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Model oluşturma durumunu sorgulayın

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

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

Parametreler:

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

Yanıt (200):

Oluşturma durumu

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

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Sürecin en son modeline ait vaka bazlı metrikler: hesaplanan sıra ve sağlık metrikleriyle her vaka için bir satır.

Bir sürecin vaka bazlı metriklerini alın (en son model, sayfalı)

Sürecin en son modeli için hesaplanan süreç metriklerini, vaka başına bir satır olarak döndürür. Bu metrikler vaka süresini, uzunluğunu, uyumluluğunu, yeniden çalışmayı, sağlık skorunu, varyantı ve daha fazlasını içerir. Satır filtresi uygulanmaz. Sonuç sayfalıdır: limit kullanın (varsayılan 1000, maksimum 10000) ve offset değerini kullanın; hasMore true olduğu sürece sayfaları almaya devam edin. Metrikler hâlâ hesaplanıyorsa yanıtın durumu preprocessing olur.

Uç nokta: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

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

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
processId string yol Evet Biçim: uuid
limit integer sorgu Hayır Döndürülecek maksimum vaka satırı sayısı (varsayılan 1000, maksimum 10000)
offset integer sorgu Hayır Atlanacak vaka satırı sayısı (varsayılan 0)

Yanıt (200):

Vaka metrikleri

{
	"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": [
		{}
	]
}

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ı
  • 503 Veri hattı hazır değil veya üst akış sorgusu başarısız oldu

Süreç sürümlerini listeleyin

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

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

Parametreler:

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

Yanıt (200):

Sürüm listesi

[
	{
		"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
	}
]

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Sürecin sürüm anlık görüntüsünü oluşturun

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

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Sürüm etiketi
Varsayılan: ""
Maksimum uzunluk: 128
description string Hayır Sürümün isteğe bağlı açıklaması
versionType manual | auto Hayır manuel = kullanıcı tarafından oluşturulan, auto = sistem tarafından oluşturulan
İzin verilen değerler: manual, auto
restoreFromVersionId string Hayır Bu anlık görüntü oluşturulurken geri yüklenecek sürüm
Biçim: uuid

Yanıt (201):

Sürüm oluşturuldu

{
	"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
	}
}
Alan Tür Zorunlu Açıklama
version object Evet
restoredFrom object Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir süreç sürümünü alın

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

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

Parametreler:

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

Yanıt (200):

Sürüm

{
	"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
	}
}
Alan Tür Zorunlu Açıklama
version object Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir süreç sürümünü yeniden adlandırın veya güncelleyin

Uç nokta: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"description": "string"
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Sürüm etiketi
Maksimum uzunluk: 128
description string Hayır Sürümün isteğe bağlı açıklaması

Yanıt (200):

Sürüm güncellendi

{
	"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
	}
}
Alan Tür Zorunlu Açıklama
version object Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir süreç sürümünü silin

Uç nokta: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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

Parametreler:

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

Yanıt (200):

Sürüm silindi

{
	"deleted": true
}
Alan Tür Zorunlu Açıklama
deleted boolean Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir artefaktı alın

Uç nokta: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parametreler:

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

Yanıt (200):

Artefakt

{
	"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"
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 500
description string Evet Maksimum uzunluk: 2000
originalFileName string Evet Varsayılan: ""
Maksimum uzunluk: 500
mimeType string Evet Varsayılan: ""
Maksimum uzunluk: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Evet İzin verilen değerler: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Evet İzin verilen değerler: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Varsayılan: modelIcon
uploadState Uploading | Ready | Failed | Deleted Evet İzin verilen değerler: Uploading, Ready, Failed, Deleted
Varsayılan: Uploading
hasThumbnail boolean Evet Varsayılan: false
sizeBytes number Evet Varsayılan: 0
createdAt string Evet Biçim: date-time
createdBy string Hayır Biçim: uuid

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir artefaktın görünen adını veya açıklamasını güncelleyin

Uç nokta: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"description": "string"
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Artefakt adı
Maksimum uzunluk: 500
description string Hayır Artefaktın isteğe bağlı açıklaması
Maksimum uzunluk: 2000

Yanıt (200):

Artefakt güncellendi

{
	"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"
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 500
description string Evet Maksimum uzunluk: 2000
originalFileName string Evet Varsayılan: ""
Maksimum uzunluk: 500
mimeType string Evet Varsayılan: ""
Maksimum uzunluk: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Evet İzin verilen değerler: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Evet İzin verilen değerler: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Varsayılan: modelIcon
uploadState Uploading | Ready | Failed | Deleted Evet İzin verilen değerler: Uploading, Ready, Failed, Deleted
Varsayılan: Uploading
hasThumbnail boolean Evet Varsayılan: false
sizeBytes number Evet Varsayılan: 0
createdAt string Evet Biçim: date-time
createdBy string Hayır Biçim: uuid

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir artefaktı silin

Uç nokta: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parametreler:

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

Yanıt (200):

Artefakt silindi

{
	"deleted": true
}
Alan Tür Zorunlu Açıklama
deleted boolean Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Artefaktı indirmek için imzalı URLye yönlendirin

Uç nokta: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

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

Parametreler:

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

Hatalar:

  • 302 İmzalı indirme URL’sine yönlendirme
  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Bir sürece eklenmiş artefaktları listeleyin

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

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

Parametreler:

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

Yanıt (200):

Süreç artefaktları listesi

[
	{
		"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"
		}
	}
]

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Yeni bir süreç artefaktı için imzalı S3 yükleme URLsi alın

Uç nokta: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

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

Parametreler:

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

İstek gövdesi:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
Alan Tür Zorunlu Açıklama
fileName string Evet
mimeType string Evet
sizeBytes number Evet
artifactType modelIcon | processArtifact | doc | levelFrontPageImage Hayır İzin verilen değerler: modelIcon, processArtifact, doc, levelFrontPageImage
Varsayılan: processArtifact

Yanıt (200):

İmzalı yükleme URLsi

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
Alan Tür Zorunlu Açıklama
artifactId string Evet Biçim: uuid
originalUrl string Evet
thumbnailUrl 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ı
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
  • 404 Kaynak bulunamadı
  • 409 İstek mevcut durumla çakışıyor (örneğin kullanıcı lisansı sınırı veya yeniden kullanılan bir kimlik)

İlgili dokümantasyon