Dokumentacja API: procesy

Te punkty końcowe działają w Państwa własnym obszarze roboczym. Rozpocznij okres próbny, aby go utworzyć i wykonać pierwsze wywołanie API.

Wyświetlanie listy procesów

Punkt końcowy: GET /v1/tenant/{tenantId}/processes

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista procesów

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

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API

Tworzenie procesu (z pustym modelem)

Punkt końcowy: POST /v1/tenant/{tenantId}/processes

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Tak	Nazwa procesu wyświetlana w drzewie procesów Maksymalna długość: 128
treeParentId	string	Nie	Identyfikator folderu nadrzędnego (null = poziom główny) Format: uuid
treeNodeType	Process | TreeGroup	Nie	Proces lub TreeGroup (folder) Dozwolone wartości: Process, TreeGroup Domyślnie: Process

Odpowiedź (201):

Utworzony 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	Wymagane	Opis
id	string	Tak	Format: uuid
treeParentId	string	Tak	Format: uuid
treeNodeType	Process | TreeGroup	Tak	Dozwolone wartości: Process, TreeGroup Wartość domyślna: Process
displayName	string	Tak	Wartość domyślna: New Process Maksymalna długość: 128
createdAt	string	Tak	Format: date-time
updatedAt	string	Tak	Format: date-time
designerModelId	string	Tak	Format: uuid

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 500 Nieoczekiwany błąd serwera. Żądanie można bezpiecznie ponowić.

Pobieranie procesu

Punkt końcowy: GET /v1/tenant/{tenantId}/processes/{processId}

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Odpowiedź (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	Wymagane	Opis
id	string	Tak	Format: uuid
treeParentId	string	Tak	Format: uuid
treeNodeType	Process | TreeGroup	Tak	Dozwolone wartości: Process, TreeGroup Wartość domyślna: Process
displayName	string	Tak	Wartość domyślna: New Process Maksymalna długość: 128
createdAt	string	Tak	Format: date-time
updatedAt	string	Tak	Format: date-time
designerModelId	string	Tak	Format: uuid

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Aktualizowanie procesu

Punkt końcowy: PUT /v1/tenant/{tenantId}/processes/{processId}

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Nazwa procesu wyświetlana w drzewie procesów Maksymalna długość: 128
treeParentId	string	Nie	Identyfikator folderu nadrzędnego (null = poziom główny) Format: uuid

Odpowiedź (200):

Zaktualizowany 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	Wymagane	Opis
id	string	Tak	Format: uuid
treeParentId	string	Tak	Format: uuid
treeNodeType	Process | TreeGroup	Tak	Dozwolone wartości: Process, TreeGroup Wartość domyślna: Process
displayName	string	Tak	Wartość domyślna: New Process Maksymalna długość: 128
createdAt	string	Tak	Format: date-time
updatedAt	string	Tak	Format: date-time
designerModelId	string	Tak	Format: uuid

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu
• 500 Nieoczekiwany błąd serwera. Żądanie można bezpiecznie ponowić.

Miękkie usuwanie procesu

Punkt końcowy: DELETE /v1/tenant/{tenantId}/processes/{processId}

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto proces

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

Pole	Typ	Wymagane	Opis
success	boolean	Tak
message	string	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Eksport modelu procesu jako XML BPMN 2.0

Punkt końcowy: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

XML BPMN

{
	"bpmnXml": "string"
}

Pole	Typ	Wymagane	Opis
bpmnXml	string	Tak	XML BPMN 2.0

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu lub dostępu do organizacji, tenant jest nieaktywny albo plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu
• 500 Nieoczekiwany błąd serwera. Żądanie można bezpiecznie ponowić.

Import modelu BPMN 2.0 do procesu (zastępuje bieżący model)

Punkt końcowy: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

{
	"bpmnXml": "string"
}

Pole	Typ	Wymagane	Opis
bpmnXml	string	Tak	XML BPMN 2.0

Odpowiedź (200):

Przesłano BPMN

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. błędne wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Mapowania danych łączą tabele danych z procesami, dzięki czemu można wizualizować i analizować dane z dziennika zdarzeń na modelu procesu.

Wyświetlanie mapowań danych dla procesu

Punkt końcowy: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista mapowań

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

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Przypisz tabelę danych do procesu (rozpoczyna przetwarzanie dziennika zdarzeń)

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
dataTableId	string	Tak	Tabela danych przypisywana do procesu Format: uuid
displayName	string	Nie	Nazwa wyświetlana przypisania Maksymalna długość: 128
color	object	Nie	Kolor akcentu
showByDefault	boolean	Nie	Czy to przypisanie ma być domyślnie widoczne w widoku procesu Domyślnie: true
mappingRole	primary | comparison	Nie	Rola przypisanych danych w modelu Dozwolone wartości: primary, comparison

Odpowiedź (201):

Utworzono przypisanie

{
	"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	Wymagane	Opis
id	string	Tak	Format: uuid
modelId	string	Tak	Format: uuid
dataTableId	string	Tak	Format: uuid
displayName	string	Tak	Maksymalna długość: 128
color	object	Tak
showByDefault	boolean	Tak	Domyślnie: true
mappingRole	primary | comparison	Tak	Dozwolone wartości: primary, comparison Domyślnie: comparison
sortOrder	integer	Tak	Domyślnie: 0 Min.: -9007199254740991 Maks.: 9007199254740991

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu

Zaktualizuj przypisanie

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
mappingId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Maksymalna długość: 128
color	object	Nie
showByDefault	boolean	Nie
mappingRole	primary | comparison	Nie	Dozwolone wartości: primary, comparison
sortOrder	integer	Nie	Min.: -9007199254740991 Maks.: 9007199254740991

Odpowiedź (200):

Zaktualizowano przypisanie

{
	"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	Wymagane	Opis
id	string	Tak	Format: uuid
modelId	string	Tak	Format: uuid
dataTableId	string	Tak	Format: uuid
displayName	string	Tak	Maksymalna długość: 128
color	object	Tak
showByDefault	boolean	Tak	Domyślnie: true
mappingRole	primary | comparison	Tak	Dozwolone wartości: primary, comparison Domyślnie: comparison
sortOrder	integer	Tak	Domyślnie: 0 Min.: -9007199254740991 Maks.: 9007199254740991

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Usuń przypisanie

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
mappingId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto przypisanie

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

Pole	Typ	Wymagane	Opis
success	boolean	Tak
message	string	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Te endpointy wykorzystują AI do automatycznego generowania modeli procesów BPMN na podstawie opisów w języku naturalnym.

Wygeneruj model procesu na podstawie polecenia w języku naturalnym (asynchronicznie; sprawdzaj status endpointu)

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write · limit 2 żądań/s (maks. 4 w krótkim czasie)

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

{
	"prompt": "string"
}

Pole	Typ	Wymagane	Opis
prompt	string	Tak

Odpowiedź (200):

Rozpoczęto generowanie / wynik

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Sprawdź status generowania modelu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Status generowania

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Metryki poszczególnych case’ów dla najnowszego modelu procesu: jeden wiersz na case z obliczoną sekwencją i metrykami kondycji.

Pobierz metryki dla poszczególnych case’ów procesu (najnowszy model, stronicowanie)

Zwraca po jednym wierszu dla każdego case’a, zawierającym obliczone metryki procesu (czas trwania, długość, zgodność, ponowne wykonania, wynik kondycji, wariant i inne) dla najnowszego modelu procesu. Nie stosuje filtrowania wierszy. Wyniki są stronicowane: użyj limit (domyślnie 1000, maks. 10000) i offset, a następnie pobieraj kolejne strony, dopóki hasMore ma wartość true. Gdy metryki są jeszcze obliczane, odpowiedź ma stan preprocessing.

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych wierszy z danymi case’ów (domyślnie 1000, maks. 10000)
offset	integer	zapytanie	Nie	Liczba pomijanych wierszy z danymi case’ów (domyślnie 0)

Odpowiedź (200):

Metryki case’ów

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

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu
• 503 Potok danych nie jest gotowy lub zapytanie do systemu nadrzędnego zakończyło się niepowodzeniem

Wyświetl wersje procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista wersji

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

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Utwórz migawkę wersji procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Etykieta wersji Domyślnie: "" Maksymalna długość: 128
description	string	Nie	Opcjonalny opis wersji
versionType	manual | auto	Nie	ręcznie = utworzona przez użytkownika, auto = utworzona przez system Dozwolone wartości: manual, auto
restoreFromVersionId	string	Nie	Wersja, z której zostanie przywrócona migawka Format: uuid

Odpowiedź (201):

Utworzono wersję

{
	"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	Wymagane	Opis
version	object	Tak
restoredFrom	object	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Pobierz wersję procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
versionId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Wersja

{
	"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	Wymagane	Opis
version	object	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Zmień nazwę lub zaktualizuj wersję procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
versionId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Etykieta wersji Maksymalna długość: 128
description	string	Nie	Opcjonalny opis wersji

Odpowiedź (200):

Zaktualizowano wersję

{
	"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	Wymagane	Opis
version	object	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Usuń wersję procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
versionId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto wersję

{
	"deleted": true
}

Pole	Typ	Wymagane	Opis
deleted	boolean	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Pobierz artefakt

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
artifactId	string	ścieżka	Tak	Format: uuid

Odpowiedź (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	Wymagane	Opis
id	string	Tak	Format: uuid
displayName	string	Tak	Domyślnie: "" Maksymalna długość: 500
description	string	Tak	Maksymalna długość: 2000
originalFileName	string	Tak	Domyślnie: "" Maksymalna długość: 500
mimeType	string	Tak	Domyślnie: "" Maksymalna długość: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Tak	Dozwolone wartości: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Tak	Dozwolone wartości: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Domyślnie: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Tak	Dozwolone wartości: Uploading, Ready, Failed, Deleted Domyślnie: Uploading
hasThumbnail	boolean	Tak	Domyślnie: false
sizeBytes	number	Tak	Domyślnie: 0
createdAt	string	Tak	Format: date-time
createdBy	string	Nie	Format: uuid

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Zmień nazwę wyświetlaną lub opis artefaktu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
artifactId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Nazwa artefaktu Maksymalna długość: 500
description	string	Nie	Opcjonalny opis artefaktu Maksymalna długość: 2000

Odpowiedź (200):

Zaktualizowano 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	Wymagane	Opis
id	string	Tak	Format: uuid
displayName	string	Tak	Domyślnie: "" Maksymalna długość: 500
description	string	Tak	Maksymalna długość: 2000
originalFileName	string	Tak	Domyślnie: "" Maksymalna długość: 500
mimeType	string	Tak	Domyślnie: "" Maksymalna długość: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Tak	Dozwolone wartości: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Tak	Dozwolone wartości: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Domyślnie: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Tak	Dozwolone wartości: Uploading, Ready, Failed, Deleted Domyślnie: Uploading
hasThumbnail	boolean	Tak	Domyślnie: false
sizeBytes	number	Tak	Domyślnie: 0
createdAt	string	Tak	Format: date-time
createdBy	string	Nie	Format: uuid

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Usuń artefakt

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
artifactId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto artefakt

{
	"deleted": true
}

Pole	Typ	Wymagane	Opis
deleted	boolean	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Przekieruj do podpisanego adresu URL, aby pobrać artefakt

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
artifactId	string	ścieżka	Tak	Format: uuid

Błędy:

• 302 Przekierowanie do podpisanego adresu URL pobierania
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Wyświetl artefakty przypisane do procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista artefaktów 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"
		}
	}
]

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Pobierz podpisany adres URL S3 do przesłania nowego artefaktu procesu

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
processId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
fileName	string	Tak
mimeType	string	Tak
sizeBytes	number	Tak
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	Nie	Dozwolone wartości: modelIcon, processArtifact, doc, levelFrontPageImage Domyślnie: processArtifact

Odpowiedź (200):

Podpisany adres URL przesyłania

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

Pole	Typ	Wymagane	Opis
artifactId	string	Tak	Format: uuid
originalUrl	string	Tak
thumbnailUrl	string	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu
• 409 Żądanie jest sprzeczne z bieżącym stanem, np. z ograniczeniem liczby licencji lub ponownym użyciem identyfikatora