Na této stránce
> zdroje > dokumentace > api > Referenční příručka API: procesy

Referenční příručka API: procesy

Tyto endpointy pracují ve vašem vlastním pracovním prostoru. Začněte zkušební verzi, vytvořte si pracovní prostor a odešlete první volání API.

Výpis procesů

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

Ověření: API key s oprávněním pro tenant · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam procesů

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

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela

Vytvoření procesu (s prázdným modelem)

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

Ověření: API key s oprávněním pro tenant · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
Pole Typ Povinné Popis
displayName string Ano Název procesu zobrazený ve stromu procesů
Maximální délka: 128
treeParentId string Ne ID nadřazené složky (null = nejvyšší úroveň)
Formát: uuid
treeNodeType Process | TreeGroup Ne Proces nebo TreeGroup (složka)
Povolené hodnoty: Process, TreeGroup
Výchozí hodnota: Process

Odpověď (201):

Proces vytvořen

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
treeParentId string Ano Formát: uuid
treeNodeType Process | TreeGroup Ano Povolené hodnoty: Process, TreeGroup
Výchozí hodnota: Process
displayName string Ano Výchozí hodnota: New Process
Maximální délka: 128
createdAt string Ano Formát: date-time
updatedAt string Ano Formát: date-time
designerModelId string Ano Formát: uuid

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 500 Neočekávaná chyba serveru. Požadavek můžete bezpečně zopakovat.

Načtení procesu

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

Ověření: API key s oprávněním pro tenant · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Odpověď (200):

Proces

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
treeParentId string Ano Formát: uuid
treeNodeType Process | TreeGroup Ano Povolené hodnoty: Process, TreeGroup
Výchozí hodnota: Process
displayName string Ano Výchozí hodnota: New Process
Maximální délka: 128
createdAt string Ano Formát: date-time
updatedAt string Ano Formát: date-time
designerModelId string Ano Formát: uuid

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen

Úprava procesu

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

Ověření: API key s oprávněním pro tenant · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
Pole Typ Povinné Popis
displayName string Ne Název procesu zobrazený ve stromu procesů
Maximální délka: 128
treeParentId string Ne ID nadřazené složky (null = nejvyšší úroveň)
Formát: uuid

Odpověď (200):

Proces aktualizován

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
treeParentId string Ano Formát: uuid
treeNodeType Process | TreeGroup Ano Povolené hodnoty: Process, TreeGroup
Výchozí hodnota: Process
displayName string Ano Výchozí hodnota: New Process
Maximální délka: 128
createdAt string Ano Formát: date-time
updatedAt string Ano Formát: date-time
designerModelId string Ano Formát: uuid

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen
  • 500 Neočekávaná chyba serveru. Požadavek můžete bezpečně zopakovat.

Logické smazání procesu

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

Ověření: API key s oprávněním pro tenant · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Odpověď (200):

Proces smazán

{
	"success": true,
	"message": "string"
}
Pole Typ Povinné Popis
success boolean Ano
message string Ano

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen

Export modelu procesu jako BPMN 2.0 XML

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

Ověření: API key s oprávněním pro tenant · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Odpověď (200):

BPMN XML

{
	"bpmnXml": "string"
}
Pole Typ Povinné Popis
bpmnXml string Ano BPMN 2.0 XML

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen
  • 500 Neočekávaná chyba serveru. Požadavek můžete bezpečně zopakovat.

Import modelu BPMN 2.0 do procesu (nahradí aktuální model)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Ověření: API key s oprávněním pro tenant · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"bpmnXml": "string"
}
Pole Typ Povinné Popis
bpmnXml string Ano BPMN 2.0 XML

Odpověď (200):

BPMN nahráno

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen

Mapování dat propojuje datové tabulky s procesy. Díky tomu můžete data ze záznamu událostí zobrazit a analyzovat v modelu procesu.

Výpis mapování dat procesu

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

Ověření: API key s oprávněním pro tenant · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam mapování

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

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Namapování datové tabulky na proces (spustí zpracování záznamu událostí)

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

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
Pole Typ Povinné Popis
dataTableId string Ano Datová tabulka, která se má namapovat na proces
Formát: uuid
displayName string Ne Zobrazovaný název mapování
Maximální délka: 128
color object Ne Barva zvýraznění
showByDefault boolean Ne Zobrazit toto mapování v zobrazení procesu ve výchozím nastavení
Výchozí hodnota: true
mappingRole primary | comparison Ne Role namapovaných dat v modelu
Povolené hodnoty: primary, comparison

Odpověď (201):

Mapování bylo vytvořeno

{
	"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
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
modelId string Ano Formát: uuid
dataTableId string Ano Formát: uuid
displayName string Ano Maximální délka: 128
color object Ano
showByDefault boolean Ano Výchozí hodnota: true
mappingRole primary | comparison Ano Povolené hodnoty: primary, comparison
Výchozí hodnota: comparison
sortOrder integer Ano Výchozí hodnota: 0
Minimum: -9007199254740991
Maximum: 9007199254740991

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 403 API klíč nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Aktualizace mapování

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
mappingId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Pole Typ Povinné Popis
displayName string Ne Maximální délka: 128
color object Ne
showByDefault boolean Ne
mappingRole primary | comparison Ne Povolené hodnoty: primary, comparison
sortOrder integer Ne Minimum: -9007199254740991
Maximum: 9007199254740991

Odpověď (200):

Mapování bylo aktualizováno

{
	"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
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
modelId string Ano Formát: uuid
dataTableId string Ano Formát: uuid
displayName string Ano Maximální délka: 128
color object Ano
showByDefault boolean Ano Výchozí hodnota: true
mappingRole primary | comparison Ano Povolené hodnoty: primary, comparison
Výchozí hodnota: comparison
sortOrder integer Ano Výchozí hodnota: 0
Minimum: -9007199254740991
Maximum: 9007199254740991

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Odstranění mapování

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
mappingId string path Ano Formát: uuid

Odpověď (200):

Mapování bylo odstraněno

{
	"success": true,
	"message": "string"
}
Pole Typ Povinné Popis
success boolean Ano
message string Ano

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Tyto endpointy pomocí AI automaticky vytvářejí BPMN modely procesů z popisů v přirozeném jazyce.

Vytvoření modelu procesu z pokynu v přirozeném jazyce (asynchronně, stav ověřujte pomocí endpointu)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Ověření: API klíč pro konkrétního tenanta · rozsah write · limit 2 požadavky/s (nárazově 4)

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"prompt": "string"
}
Pole Typ Povinné Popis
prompt string Ano

Odpověď (200):

Generování bylo zahájeno / výsledek

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Ověření stavu generování modelu

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Odpověď (200):

Stav generování

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Metriky jednotlivých případů podle nejnovějšího modelu procesu: jeden řádek na případ s vypočtenou posloupností a metrikami stavu procesu.

Získání metrik jednotlivých případů procesu (nejnovější model, stránkované výsledky)

Vrací jeden řádek pro každý případ s vypočtenými metrikami procesu (doba trvání případu, délka, shoda, přepracování, skóre stavu, varianta a další) podle nejnovějšího modelu procesu. Řádky se nefiltrují. Výsledky jsou stránkované: použijte limit (výchozí hodnota 1000, maximum 10000) a offset a pokračujte, dokud je hasMore true. Dokud se metriky počítají, odpověď má stav preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených řádků případů (výchozí hodnota 1000, maximum 10000)
offset integer query Ne Počet přeskočených řádků případů (výchozí hodnota 0)

Odpověď (200):

Metriky případů

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

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen
  • 503Datová pipeline není připravena nebo selhal navazující dotaz

Výpis verzí procesu

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

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam verzí

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

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Vytvoření snímku verze procesu

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

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
Pole Typ Povinné Popis
displayName string Ne Označení verze
Výchozí hodnota: ""
Maximální délka: 128
description string Ne Volitelný popis verze
versionType manual | auto Ne ručně = vytvořeno uživatelem, auto = vytvořeno systémem
Povolené hodnoty: manual, auto
restoreFromVersionId string Ne Verze, ze které se při vytváření tohoto snímku obnoví data
Formát: uuid

Odpověď (201):

Verze byla vytvořena

{
	"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
	}
}
Pole Typ Povinné Popis
version object Ano
restoredFrom object Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Načtení verze procesu

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
versionId string path Ano Formát: uuid

Odpověď (200):

Verze

{
	"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
	}
}
Pole Typ Povinné Popis
version object Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Přejmenování nebo aktualizace verze procesu

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
versionId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"description": "string"
}
Pole Typ Povinné Popis
displayName string Ne Označení verze
Maximální délka: 128
description string Ne Volitelný popis verze

Odpověď (200):

Verze byla aktualizována

{
	"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
	}
}
Pole Typ Povinné Popis
version object Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Odstranění verze procesu

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
versionId string path Ano Formát: uuid

Odpověď (200):

Verze byla odstraněna

{
	"deleted": true
}
Pole Typ Povinné Popis
deleted boolean Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Načtení artefaktu

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
artifactId string path Ano Formát: uuid

Odpověď (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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
displayName string Ano Výchozí hodnota: ""
Maximální délka: 500
description string Ano Maximální délka: 2000
originalFileName string Ano Výchozí hodnota: ""
Maximální délka: 500
mimeType string Ano Výchozí hodnota: ""
Maximální délka: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Ano Povolené hodnoty: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Ano Povolené hodnoty: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Výchozí hodnota: modelIcon
uploadState Uploading | Ready | Failed | Deleted Ano Povolené hodnoty: Uploading, Ready, Failed, Deleted
Výchozí hodnota: Uploading
hasThumbnail boolean Ano Výchozí hodnota: false
sizeBytes number Ano Výchozí hodnota: 0
createdAt string Ano Formát: date-time
createdBy string Ne Formát: uuid

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Změna zobrazovaného názvu nebo popisu artefaktu

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
artifactId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"description": "string"
}
Pole Typ Povinné Popis
displayName string Ne Název artefaktu
Maximální délka: 500
description string Ne Volitelný popis artefaktu
Maximální délka: 2000

Odpověď (200):

Artefakt byl aktualizován

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
displayName string Ano Výchozí hodnota: ""
Maximální délka: 500
description string Ano Maximální délka: 2000
originalFileName string Ano Výchozí hodnota: ""
Maximální délka: 500
mimeType string Ano Výchozí hodnota: ""
Maximální délka: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Ano Povolené hodnoty: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Ano Povolené hodnoty: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Výchozí hodnota: modelIcon
uploadState Uploading | Ready | Failed | Deleted Ano Povolené hodnoty: Uploading, Ready, Failed, Deleted
Výchozí hodnota: Uploading
hasThumbnail boolean Ano Výchozí hodnota: false
sizeBytes number Ano Výchozí hodnota: 0
createdAt string Ano Formát: date-time
createdBy string Ne Formát: uuid

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Odstranění artefaktu

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
artifactId string path Ano Formát: uuid

Odpověď (200):

Artefakt byl odstraněn

{
	"deleted": true
}
Pole Typ Povinné Popis
deleted boolean Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Přesměrování na podepsanou URL pro stažení artefaktu

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
artifactId string path Ano Formát: uuid

Chyby:

  • 302 Přesměrování na podepsanou URL pro stažení
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Výpis artefaktů připojených k procesu

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

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam artefaktů procesu

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

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Získání podepsané S3 URL pro nahrání nového artefaktu procesu

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
Pole Typ Povinné Popis
fileName string Ano
mimeType string Ano
sizeBytes number Ano
artifactType modelIcon | processArtifact | doc | levelFrontPageImage Ne Povolené hodnoty: modelIcon, processArtifact, doc, levelFrontPageImage
Výchozí hodnota: processArtifact

Odpověď (200):

Podepsaná URL pro nahrání

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
Pole Typ Povinné Popis
artifactId string Ano Formát: uuid
originalUrl string Ano
thumbnailUrl string Ano

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 403 API klíč nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen
  • 409 Požadavek je v konfliktu s aktuálním stavem (například kvůli omezení počtu licencí nebo opakovanému použití ID)

Související dokumentace

Navrhujte lepší procesy. Propojte je do společné architektury. Mějte vše pod kontrolou.

Získejte přístup ihned, bez čekání a bez platební karty. Převádějte způsob práce ve své organizaci do přehledných a propojených návrhů procesů.

Vytvořte architekturu procesů, určete vlastníky a kontrolní mechanismy a slaďte role a odpovědnosti na všech úrovních.

Spusťte zkušební verzi a vytvořte spolehlivý základ pro řízení, správu a průběžné zlepšování procesů.

Získejte zkušební verzi zdarma