Na této stránce

> zdroje > dokumentace > api > Reference API: data

Reference API: data

warning

Odstraněním datasetu trvale smažete všechny související datové tabulky a data. Tuto akci nelze vrátit zpět.

Použití:

# Get the presigned URL with required parameters
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{datatableId}/uploads/presigned-url?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

Platnost předem podepsaných URL po určité době vyprší. Použijte URL co nejdříve po jejím získání. Pokud nahrávání selže, vyžádejte si novou předem podepsanou URL.

Použití:

# Get the download URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/download")

# Extract URL and download the file
DOWNLOAD_URL=$(echo $RESPONSE | jq -r '.downloadUrl')
curl -o "data.csv" "$DOWNLOAD_URL"

info

U nahraných datových tabulek zůstává zachován původní formát souboru (CSV, Parquet, ORC, JSONL nebo Excel). Výsledky simulace jsou vždy ve formátu CSV.

Použití:

# Get delta presigned URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url?delta=true&filename=delta.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the delta file
UPLOAD_URL=$(echo $RESPONSE | jq -r '.PreSignedUploadUrl')
curl -X PUT --upload-file "delta.csv" -H "Content-Type: text/csv" "$UPLOAD_URL"

info

Před nahráním přírůstkových dat musí datová tabulka obsahovat počáteční data. Soubor s přírůstkovými daty musí mít stejný formát jako původní soubor (například přírůstek CSV pro původní CSV nebo přírůstek Parquet pro původní Parquet) a stejnou strukturu sloupců. Nahrávání přírůstků ve formátu Excel a XES není podporováno.

info

Po nahrání přes předem podepsanou URL ProcessMind přírůstek automaticky zpracuje a spojí s původními daty. Opakovaně kontrolujte GET /datatables/{dataTableId}, dokud hasDataLoaded nebude mít hodnotu true. Tím zjistíte, kdy je zpracování dokončeno.

Datasety sdružují související datové tabulky, které spolu logicky patří.

Zobrazit datasety

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

Ověření: API key vázaný na tenant · rozsah 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 datasetů

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Dataset",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"dataTableId": "00000000-0000-0000-0000-000000000000"
	}
]

Chyby:

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

Vytvořit dataset (s prázdnou datovou tabulkou)

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

Ověření: API key vázaný na tenant · rozsah 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": "Dataset"
}

Pole	Typ	Povinné	Popis
displayName	string	Ano	Název datové sady zobrazený ve stromu dat Maximální délka: 128
treeParentId	string	Ne	ID nadřazené složky (null = nejvyšší úroveň) Formát: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ne	Datová sada nebo složka Povolené hodnoty: `Dataset`, `TreeGroup` Výchozí hodnota: `Dataset`

Odpověď (201):

Vytvořený dataset

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "00000000-0000-0000-0000-000000000000"
}

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: `uuid`
treeParentId	string	Ano	Formát: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ano	Povolené hodnoty: `Dataset`, `TreeGroup` Výchozí hodnota: `Dataset`
displayName	string	Ano	Výchozí hodnota: `""` Maximální délka: 128
createdAt	string	Ano	Formát: `date-time`
updatedAt	string	Ano	Formát: `date-time`
dataTableId	string	Ano	Formát: `uuid`

Chyby:

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

Načíst dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}

Ověření: API key vázaný na tenant · rozsah oprávnění read

Parametry:

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

Odpověď (200):

Dataset

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "00000000-0000-0000-0000-000000000000"
}

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: `uuid`
treeParentId	string	Ano	Formát: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ano	Povolené hodnoty: `Dataset`, `TreeGroup` Výchozí hodnota: `Dataset`
displayName	string	Ano	Výchozí hodnota: `""` Maximální délka: 128
createdAt	string	Ano	Formát: `date-time`
updatedAt	string	Ano	Formát: `date-time`
dataTableId	string	Ano	Formát: `uuid`

Chyby:

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

Logicky odstranit dataset

Endpoint: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Odpověď (200):

Dataset odstraněn

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

Pole	Typ	Povinné	Popis
success	boolean	Ano
message	string	Ano

Chyby:

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

Zobrazit datové tabulky datasetu

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Ověření: API key vázaný na tenant · rozsah oprávnění read

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	path	Ano	Formát: `uuid`
datasetId	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 datových tabulek v datasetu

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

Chyby:

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

Vytvořit prázdnou datovou tabulku v datasetu

Endpoint: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"displayName": "string"
}

Pole	Typ	Povinné	Popis
displayName	string	Ano	Název datové tabulky Maximální délka: 128

Odpověď (201):

Vytvořená datová tabulka

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: `uuid`
datasetId	string	Ano	Formát: `uuid`
displayName	string	Ano	Výchozí hodnota: `""` Maximální délka: 128
createdAt	string	Ano	Formát: `date-time`
updatedAt	string	Ano	Formát: `date-time`
hasDataLoaded	boolean	Ano	Výchozí hodnota: `false`
filterExpression	string	Ano	Maximální délka: 4 096
metaInfo	object \| object \| object \| object	Ano

Chyby:

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

Datové tabulky uchovávají samotná data záznamu událostí, která se používají pro process mining.

Zobrazit datové tabulky

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

Ověření: API key vázaný na tenant · rozsah 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 datových tabulek

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

Chyby:

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

Načíst datovou tabulku

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Ověření: API key vázaný na tenant · rozsah oprávnění read

Parametry:

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

Odpověď (200):

Datová tabulka

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: `uuid`
datasetId	string	Ano	Formát: `uuid`
displayName	string	Ano	Výchozí hodnota: `""` Maximální délka: 128
createdAt	string	Ano	Formát: `date-time`
updatedAt	string	Ano	Formát: `date-time`
hasDataLoaded	boolean	Ano	Výchozí hodnota: `false`
filterExpression	string	Ano	Maximální délka: 4 096
metaInfo	object \| object \| object \| object	Ano

Chyby:

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

Aktualizovat datovou tabulku (displayName, parseSettings, …)

Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"displayName": "string",
	"filterExpression": "string"
}

Pole	Typ	Povinné	Popis
displayName	string	Ne	Název datové tabulky Maximální délka: 128
filterExpression	string	Ne	Výraz filtru použitý na data Maximální délka: 4 096

Odpověď (200):

Aktualizovaná datová tabulka

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: `uuid`
datasetId	string	Ano	Formát: `uuid`
displayName	string	Ano	Výchozí hodnota: `""` Maximální délka: 128
createdAt	string	Ano	Formát: `date-time`
updatedAt	string	Ano	Formát: `date-time`
hasDataLoaded	boolean	Ano	Výchozí hodnota: `false`
filterExpression	string	Ano	Maximální délka: 4 096
metaInfo	object \| object \| object \| object	Ano

Chyby:

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

Získat předem podepsanou URL ke stažení zdrojového souboru datové tabulky

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Ověření: API key vázaný na tenant · rozsah oprávnění read

Parametry:

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

Odpověď (200):

URL ke stažení

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}

Pole	Typ	Povinné	Popis
downloadUrl	string	Ano
expiresInSeconds	number	Ano

Chyby:

400 Neplatný 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ý, vypnutý nebo jeho platnost vypršela
404 Zdroj nebyl nalezen

Zrušit vícedílné nahrávání a zahodit nahrané části

API key musí mít rozsah oprávnění uploadData.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"uploadId": "string",
	"uploadHandle": "string"
}

Pole	Typ	Povinné	Popis
uploadId	string	Ano
uploadHandle	string	Ano	Neprůhledný identifikátor vrácený při zahájení nahrávání

Odpověď (200):

Zrušeno

{
	"message": "string"
}

Pole	Typ	Povinné	Popis
message	string	Ano

Chyby:

401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
403 API key nemá požadovaný rozsah oprávnění nebo přístup k organizaci, tenant není aktivní nebo tarif nepovoluje daný typ souboru
404 Zdroj nebyl nalezen

Dokončit vícedílné nahrávání (krok 3 ze 3)

API key musí mít rozsah oprávnění uploadData. Spojí nahrané části (pomocí jejich ETag) a spustí zpracování záznamu událostí.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}

Pole	Typ	Povinné	Popis
uploadId	string	Ano
uploadHandle	string	Ano	Neprůhledný identifikátor vrácený při zahájení nahrávání
parts	object[]	Ano

Odpověď (200):

Dokončeno ({ completed: true })

{
	"message": "string"
}

Pole	Typ	Povinné	Popis
message	string	Ano

Chyby:

401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
403 API key nemá požadovaný rozsah oprávnění nebo přístup k organizaci, tenant není aktivní nebo tarif nepovoluje daný typ souboru
404 Zdroj nebyl nalezen

Zahájit vícedílné (po částech) nahrávání dat záznamu událostí (krok 1 ze 3)

API key musí mít rozsah oprávnění uploadData. Vrátí uploadId a neprůhledný uploadHandle, které je potřeba předat v následujících voláních parts, complete a abort. Vhodné pro velké soubory.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}

Pole	Typ	Povinné	Popis
fileName	string	Ano
fileSize	number	Ano
fileLastModified	number	Ano
partCount	number	Ne	Počet částí, pro které se mají vytvořit předem podepsané URL (výchozí hodnota 10)
delta	boolean	Ne	Určuje, zda jde o přírůstkové nahrávání
datasetId	string	Ne	Formát: `uuid`
modelId	string	Ne	Formát: `uuid`

Odpověď (200):

Nahrávání zahájeno

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}

Pole	Typ	Povinné	Popis
uploadId	string	Ne
uploadHandle	string	Ne	Neprůhledný identifikátor pro kroky nahrání částí, dokončení a zrušení
partCount	number	Ne
partSizeBytes	number	Ne

Chyby:

401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
403 API key nemá požadovaný rozsah oprávnění nebo přístup k organizaci, tenant není aktivní nebo tarif nepovoluje daný typ souboru
404 Zdroj nebyl nalezen

Získat předem podepsané URL pro části vícedílného nahrávání (krok 2 ze 3)

API key musí mít rozsah oprávnění uploadData. Pro každé požadované číslo části vrátí jednu předem podepsanou URL PUT.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

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

Tělo požadavku:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}

Pole	Typ	Povinné	Popis
uploadId	string	Ano
uploadHandle	string	Ano	Neprůhledný identifikátor vrácený při zahájení nahrávání
partNumbers	number[]	Ano

Odpověď (200):

Předem podepsaná URL pro části ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Pole	Typ	Povinné	Popis
message	string	Ano

Chyby:

401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
403 API key nemá požadovaný rozsah oprávnění nebo přístup k organizaci, tenant není aktivní nebo tarif nepovoluje daný typ souboru
404 Zdroj nebyl nalezen

Získat předem podepsanou S3 URL pro nahrání dat záznamu událostí (CSV/XLSX, úplná data nebo přírůstek)

API key musí mít rozsah oprávnění uploadData, nezávisle na oprávněních ke čtení a zápisu. Deklarovaná hodnota filesize v bajtech se porovná s maximální velikostí nahrávaného souboru na platformě. Skutečná velikost objektu se ověří znovu po nahrání souboru.

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Ověření: API key vázaný na tenant · rozsah oprávnění read

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	path	Ano	Formát: `uuid`
dataTableId	string	path	Ano	Formát: `uuid`
filename	string	query	Ano
filesize	string	query	Ano	Velikost souboru v bajtech (porovnává se s maximální velikostí nahrávaného souboru na platformě)
filelastmodified	string	query	Ano
datasetid	string	query	Ne	Povinné pro úplné nahrání, nikoli pro přírůstek
modelid	string	query	Ne	Formát: `uuid`
delta	`true` \| `false`	query	Ne	Povolené hodnoty: `true`, `false`
partnumber	string	query	Ne
validforseconds	integer	query	Ne	Platnost předem podepsané URL v sekundách (1–3 600, výchozí hodnota 3 600)

Odpověď (200):

Předem podepsaná URL

{
	"PreSignedUploadUrl": "string"
}

Pole	Typ	Povinné	Popis
PreSignedUploadUrl	string	Ano	Předem podepsaná S3 URL PUT (platnost přibližně 1 hodina)

Chyby:

401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
403 API key nemá požadovaný rozsah oprávnění nebo přístup k organizaci, tenant není aktivní nebo tarif nepovoluje daný typ souboru
404 Zdroj nebyl nalezen
413 Soubor překračuje maximální velikost nahrávání na platformě

Související dokumentace

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

Referenční příručka API pro správu organizací a uživatelů.

Dokumentace API: tenanti

Dokumentace API pro endpointy správy tenantů a řízení přístupu uživatelů.

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

Referenční příručka API pro správu procesů a endpointy mapování dat.

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

Referenční příručka API pro správu simulací a endpointy pro jejich generování pomocí AI.

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