Ezen az oldalon

> erőforrások > dokumentáció > api > API referencia: folyamatok

API-referencia: folyamatok

Ezek a végpontok a saját munkaterületén működnek. Indítson próbaverziót a munkaterület létrehozásához, majd küldje el az első API-hívását.

Folyamatok listázása

Végpont: GET /v1/tenant/{tenantId}/processes

Hitelesítés: Bérlőhöz kötött API-kulcs · read jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
limit	integer	lekérdezés	Nem	A visszaadandó elemek maximális száma
offset	integer	lekérdezés	Nem	Kihagyandó elemek száma

Válasz (200):

Folyamatok listája

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

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Folyamat létrehozása (üres modellel)

Végpont: POST /v1/tenant/{tenantId}/processes

Hitelesítés: Bérlőhöz kötött API-kulcs · write jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

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

Mező	Típus	Kötelező	Leírás
displayName	string	Igen	A folyamat neve a folyamatfában Maximális hossz: 128
treeParentId	string	Nem	Szülőmappa azonosítója (null = legfelső szint) Formátum: `uuid`
treeNodeType	`Process` \| `TreeGroup`	Nem	Folyamat vagy TreeGroup (mappa) Engedélyezett értékek: `Process`, `TreeGroup` Alapértelmezett: `Process`

Válasz (201):

Létrehozott folyamat

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
treeParentId	string	Igen	Formátum: `uuid`
treeNodeType	`Process` \| `TreeGroup`	Igen	Engedélyezett értékek: `Process`, `TreeGroup` Alapértelmezett: `Process`
displayName	string	Igen	Alapértelmezett: `New Process` Maximális hossz: 128
createdAt	string	Igen	Formátum: `date-time`
updatedAt	string	Igen	Formátum: `date-time`
designerModelId	string	Igen	Formátum: `uuid`

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
500 Váratlan szerverhiba: a kérés biztonságosan újrapróbálható

Folyamat lekérése

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

Folyamat

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
treeParentId	string	Igen	Formátum: `uuid`
treeNodeType	`Process` \| `TreeGroup`	Igen	Engedélyezett értékek: `Process`, `TreeGroup` Alapértelmezett: `Process`
displayName	string	Igen	Alapértelmezett: `New Process` Maximális hossz: 128
createdAt	string	Igen	Formátum: `date-time`
updatedAt	string	Igen	Formátum: `date-time`
designerModelId	string	Igen	Formátum: `uuid`

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamat módosítása

Végpont: PUT /v1/tenant/{tenantId}/processes/{processId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

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

Mező	Típus	Kötelező	Leírás
displayName	string	Nem	A folyamat neve a folyamatfában Maximális hossz: 128
treeParentId	string	Nem	Szülőmappa azonosítója (null = legfelső szint) Formátum: `uuid`

Válasz (200):

Módosított folyamat

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
treeParentId	string	Igen	Formátum: `uuid`
treeNodeType	`Process` \| `TreeGroup`	Igen	Engedélyezett értékek: `Process`, `TreeGroup` Alapértelmezett: `Process`
displayName	string	Igen	Alapértelmezett: `New Process` Maximális hossz: 128
createdAt	string	Igen	Formátum: `date-time`
updatedAt	string	Igen	Formátum: `date-time`
designerModelId	string	Igen	Formátum: `uuid`

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található
500 Váratlan szerverhiba: a kérés biztonságosan újrapróbálható

Folyamat logikai törlése

Végpont: DELETE /v1/tenant/{tenantId}/processes/{processId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

Folyamat törölve

{
	"success": true,
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
success	boolean	Igen
message	string	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamatmodell exportálása BPMN 2.0 XML-fájlként

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Hitelesítés: Bérlőhöz kötött API-kulcs · read jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

BPMN XML

{
	"bpmnXml": "string"
}

Mező	Típus	Kötelező	Leírás
bpmnXml	string	Igen	BPMN 2.0 XML

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
404 Az erőforrás nem található
500 Váratlan szerverhiba: a kérés biztonságosan újrapróbálható

BPMN 2.0 modell importálása a folyamathoz (felváltja a jelenlegi modellt)

Végpont: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Hitelesítés: Bérlőhöz kötött API-kulcs · write jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"bpmnXml": "string"
}

Mező	Típus	Kötelező	Leírás
bpmnXml	string	Igen	BPMN 2.0 XML

Válasz (200):

BPMN feltöltve

{
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
message	string	Igen

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Az adat-hozzárendelések adat táblákat kapcsolnak a folyamatokhoz, így az eseménynapló adatai megjeleníthetők és elemezhetők a folyamatmodellen.

Folyamat adat-hozzárendeléseinek listázása

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Hitelesítés: Bérlőhöz kötött API-kulcs · read jogosultság

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
limit	integer	lekérdezés	Nem	A visszaadandó elemek maximális száma
offset	integer	lekérdezés	Nem	Kihagyandó elemek száma

Válasz (200):

Hozzárendelések listája

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

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Adattábla hozzárendelése a folyamathoz (elindítja az eseménynapló feldolgozását)

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Mező	Típus	Kötelező	Leírás
dataTableId	string	Igen	A folyamathoz hozzárendelendő adattábla Formátum: `uuid`
displayName	string	Nem	A hozzárendelés megjelenített neve Maximális hossz: 128
color	object	Nem	Kiemelőszín
showByDefault	boolean	Nem	A hozzárendelés alapértelmezett megjelenítése a folyamatnézetben Alapértelmezett: `true`
mappingRole	`primary` \| `comparison`	Nem	A hozzárendelt adatok szerepe a modellben Engedélyezett értékek: `primary`, `comparison`

Válasz (201):

A hozzárendelés létrejött

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
modelId	string	Igen	Formátum: `uuid`
dataTableId	string	Igen	Formátum: `uuid`
displayName	string	Igen	Maximális hossz: 128
color	object	Igen
showByDefault	boolean	Igen	Alapértelmezett: `true`
mappingRole	`primary` \| `comparison`	Igen	Engedélyezett értékek: `primary`, `comparison` Alapértelmezett: `comparison`
sortOrder	integer	Igen	Alapértelmezett: `0` Minimum: -9007199254740991 Maximum: 9007199254740991

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
403 Az API-kulcs nem rendelkezik a szükséges hatókörrel vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
404 Az erőforrás nem található

Hozzárendelés frissítése

Végpont: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
mappingId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Mező	Típus	Kötelező	Leírás
displayName	string	Nem	Maximális hossz: 128
color	object	Nem
showByDefault	boolean	Nem
mappingRole	`primary` \| `comparison`	Nem	Engedélyezett értékek: `primary`, `comparison`
sortOrder	integer	Nem	Minimum: -9007199254740991 Maximum: 9007199254740991

Válasz (200):

A hozzárendelés frissült

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
modelId	string	Igen	Formátum: `uuid`
dataTableId	string	Igen	Formátum: `uuid`
displayName	string	Igen	Maximális hossz: 128
color	object	Igen
showByDefault	boolean	Igen	Alapértelmezett: `true`
mappingRole	`primary` \| `comparison`	Igen	Engedélyezett értékek: `primary`, `comparison` Alapértelmezett: `comparison`
sortOrder	integer	Igen	Alapértelmezett: `0` Minimum: -9007199254740991 Maximum: 9007199254740991

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Hozzárendelés törlése

Végpont: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
mappingId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

A hozzárendelés törölve

{
	"success": true,
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
success	boolean	Igen
message	string	Igen

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Ezek a végpontok AI segítségével, természetes nyelvű leírásokból automatikusan BPMN-folyamatmodelleket készítenek.

Folyamatmodell létrehozása természetes nyelvű utasításból (aszinkron, kérdezze le az állapotot a státuszvégponton)

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör · sebességkorlát: 2 kérés/másodperc (rövid idejű csúcs: 4)

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"prompt": "string"
}

Mező	Típus	Kötelező	Leírás
prompt	string	Igen

Válasz (200):

A létrehozás elindult / eredmény

{
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
message	string	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Modellgenerálás állapotának lekérdezése

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

Generálási állapot

{
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
message	string	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

A folyamat legutóbbi modelljének esetszintű mutatói: minden esethez egy sor tartozik a kiszámított sorrenddel és állapotmutatókkal.

Folyamat esetszintű mutatóinak lekérése (legutóbbi modell, lapozva)

A folyamat legutóbbi modelljéhez esetenként egy sort ad vissza a kiszámított folyamatmutatókkal (az eset időtartama, hossza, megfelelősége, újramunkálása, állapotpontszáma, változata és egyebek). A rendszer nem szűri a sorokat. Az eredmény lapozva érhető el: használja a limit paramétert (alapértelmezés: 1000, maximum: 10000) és a offset paramétert, majd folytassa a lapozást, amíg a hasMore értéke true. Amíg a mutatók számítása folyamatban van, a válasz állapota preprocessing.

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
limit	integer	lekérdezés	Nem	A visszaadandó esetsorok maximális száma (alapértelmezés: 1000, maximum: 10000)
offset	integer	lekérdezés	Nem	Kihagyandó esetsorok száma (alapértelmezés: 0)

Válasz (200):

Esetmutatók

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

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található
503 Az adatfeldolgozási folyamat még nem áll készen, vagy egy upstream lekérdezés sikertelen volt

Folyamatverziók listázása

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/versions

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
limit	integer	lekérdezés	Nem	A visszaadandó elemek maximális száma
offset	integer	lekérdezés	Nem	Kihagyandó elemek száma

Válasz (200):

Verziók listája

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

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamatverzió-pillanatkép létrehozása

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/versions

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Mező	Típus	Kötelező	Leírás
displayName	string	Nem	Verziócímke Alapértelmezett: `""` Maximális hossz: 128
description	string	Nem	A verzió opcionális leírása
versionType	`manual` \| `auto`	Nem	manual = felhasználó által létrehozott, auto = a rendszer által létrehozott Engedélyezett értékek: `manual`, `auto`
restoreFromVersionId	string	Nem	A pillanatkép létrehozásakor visszaállítandó verzió Formátum: `uuid`

Válasz (201):

A verzió létrejött

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

Mező	Típus	Kötelező	Leírás
version	object	Igen
restoredFrom	object	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamatverzió lekérése

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
versionId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

Verzió

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

Mező	Típus	Kötelező	Leírás
version	object	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamatverzió átnevezése vagy frissítése

Végpont: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
versionId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"displayName": "string",
	"description": "string"
}

Mező	Típus	Kötelező	Leírás
displayName	string	Nem	Verziócímke Maximális hossz: 128
description	string	Nem	A verzió opcionális leírása

Válasz (200):

Frissített verzió

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

Mező	Típus	Kötelező	Leírás
version	object	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamatverzió törlése

Végpont: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
versionId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

A verzió törölve

{
	"deleted": true
}

Mező	Típus	Kötelező	Leírás
deleted	boolean	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Fájl lekérése

Végpont: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
artifactId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

Fájl

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
displayName	string	Igen	Alapértelmezett: `""` Maximális hossz: 500
description	string	Igen	Maximális hossz: 2000
originalFileName	string	Igen	Alapértelmezett: `""` Maximális hossz: 500
mimeType	string	Igen	Alapértelmezett: `""` Maximális hossz: 200
kind	`Image` \| `Pdf` \| `Docx` \| `Xlsx` \| `Pptx` \| `Text` \| `Video`	Igen	Engedélyezett értékek: `Image`, `Pdf`, `Docx`, `Xlsx`, `Pptx`, `Text`, `Video`
artifactType	`modelIcon` \| `processArtifact` \| `doc` \| `orgDoc` \| `levelFrontPageImage`	Igen	Engedélyezett értékek: `modelIcon`, `processArtifact`, `doc`, `orgDoc`, `levelFrontPageImage` Alapértelmezett: `modelIcon`
uploadState	`Uploading` \| `Ready` \| `Failed` \| `Deleted`	Igen	Engedélyezett értékek: `Uploading`, `Ready`, `Failed`, `Deleted` Alapértelmezett: `Uploading`
hasThumbnail	boolean	Igen	Alapértelmezett: `false`
sizeBytes	number	Igen	Alapértelmezett: `0`
createdAt	string	Igen	Formátum: `date-time`
createdBy	string	Nem	Formátum: `uuid`

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Fájl megjelenített nevének vagy leírásának frissítése

Végpont: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
artifactId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"displayName": "string",
	"description": "string"
}

Mező	Típus	Kötelező	Leírás
displayName	string	Nem	A fájl neve Maximális hossz: 500
description	string	Nem	A fájl opcionális leírása Maximális hossz: 2000

Válasz (200):

Frissített fájl

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: `uuid`
displayName	string	Igen	Alapértelmezett: `""` Maximális hossz: 500
description	string	Igen	Maximális hossz: 2000
originalFileName	string	Igen	Alapértelmezett: `""` Maximális hossz: 500
mimeType	string	Igen	Alapértelmezett: `""` Maximális hossz: 200
kind	`Image` \| `Pdf` \| `Docx` \| `Xlsx` \| `Pptx` \| `Text` \| `Video`	Igen	Engedélyezett értékek: `Image`, `Pdf`, `Docx`, `Xlsx`, `Pptx`, `Text`, `Video`
artifactType	`modelIcon` \| `processArtifact` \| `doc` \| `orgDoc` \| `levelFrontPageImage`	Igen	Engedélyezett értékek: `modelIcon`, `processArtifact`, `doc`, `orgDoc`, `levelFrontPageImage` Alapértelmezett: `modelIcon`
uploadState	`Uploading` \| `Ready` \| `Failed` \| `Deleted`	Igen	Engedélyezett értékek: `Uploading`, `Ready`, `Failed`, `Deleted` Alapértelmezett: `Uploading`
hasThumbnail	boolean	Igen	Alapértelmezett: `false`
sizeBytes	number	Igen	Alapértelmezett: `0`
createdAt	string	Igen	Formátum: `date-time`
createdBy	string	Nem	Formátum: `uuid`

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Fájl törlése

Végpont: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
artifactId	string	útvonal	Igen	Formátum: `uuid`

Válasz (200):

A fájl törölve

{
	"deleted": true
}

Mező	Típus	Kötelező	Leírás
deleted	boolean	Igen

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Átirányítás előre aláírt URL-re a fájl letöltéséhez

Végpont: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
artifactId	string	útvonal	Igen	Formátum: `uuid`

Hibák:

302 Átirányítás az előre aláírt letöltési URL-re
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Folyamathoz csatolt fájlok listázása

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`
limit	integer	lekérdezés	Nem	A visszaadandó elemek maximális száma
offset	integer	lekérdezés	Nem	Kihagyandó elemek száma

Válasz (200):

Folyamatfájlok listája

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

Hibák:

401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
404 Az erőforrás nem található

Előre aláírt S3-feltöltési URL lekérése új folyamatfájlhoz

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: `uuid`
processId	string	útvonal	Igen	Formátum: `uuid`

Kérés törzse:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Mező	Típus	Kötelező	Leírás
fileName	string	Igen
mimeType	string	Igen
sizeBytes	number	Igen
artifactType	`modelIcon` \| `processArtifact` \| `doc` \| `levelFrontPageImage`	Nem	Engedélyezett értékek: `modelIcon`, `processArtifact`, `doc`, `levelFrontPageImage` Alapértelmezett: `processArtifact`

Válasz (200):

Előre aláírt feltöltési URL

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Mező	Típus	Kötelező	Leírás
artifactId	string	Igen	Formátum: `uuid`
originalUrl	string	Igen
thumbnailUrl	string	Igen

Hibák:

400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
403 Az API-kulcs nem rendelkezik a szükséges hatókörrel vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
404 Az erőforrás nem található
409 A kérés ütközik az aktuális állapottal (például felhasználói licenckorlát vagy már használt azonosító miatt)

Kapcsolódó dokumentáció

API-referencia: szervezetek

API-referencia a szervezetek kezelésére és a felhasználók adminisztrációjára szolgáló végpontokhoz.

API-referencia: bérlők

API-referencia a bérlők kezelésére és a felhasználói hozzáférések szabályozására szolgáló végpontokhoz.

API-referencia: adatok

API-referencia az adatkészletek és datatable-ök kezelésére szolgáló végpontokhoz.

API-referencia: szimulációk

API-referencia a szimulációk kezeléséhez és az AI-alapú generálási végpontokhoz.

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.

Indítsa el ingyenes próbaverzióját