Op deze pagina

> bronnen > documentatie > api > API documentatie: data

API-documentatie: data

warning

Als je een dataset verwijdert, worden alle bijbehorende datatabellen en data definitief verwijderd. Deze actie kan niet ongedaan worden gemaakt.

Gebruik:

# 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

Ondertekende URL’s verlopen na een beperkte tijd. Gebruik de URL kort nadat je deze hebt ontvangen. Mislukt de upload? Vraag dan een nieuwe ondertekende URL aan.

Gebruik:

# 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

Bij geüploade datatabellen blijft de oorspronkelijke bestandsindeling behouden (CSV, Parquet, ORC, JSONL of Excel). Resultaten van simulaties worden altijd opgeslagen als CSV-bestand.

Gebruik:

# 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

Voordat je delta-uploads kunt gebruiken, moet er al initiële data in de datatabel staan. Het delta-bestand moet dezelfde indeling hebben als het oorspronkelijke bestand (bijvoorbeeld een CSV-delta voor een oorspronkelijk CSV-bestand of een Parquet-delta voor een oorspronkelijk Parquet-bestand) en dezelfde kolomstructuur. Excel- en XES-bestanden worden niet ondersteund voor delta-uploads.

info

Na de upload via de ondertekende URL verwerkt ProcessMind de delta automatisch en voegt deze samen met de oorspronkelijke data. Vraag de status op via GET /datatables/{dataTableId} totdat hasDataLoaded de waarde true heeft. Dan is de verwerking klaar.

Datasets zijn verzamelingen van datatabellen die inhoudelijk bij elkaar horen.

Datasets weergeven

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
limit	integer	query	Nee	Maximumaantal items in het resultaat
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met datasets

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

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen

Een dataset maken (met een lege datatabel)

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Ja	Naam van de dataset zoals die in de datastructuur wordt weergegeven Maximale lengte: 128
treeParentId	string	Nee	ID van de bovenliggende map (null = hoogste niveau) Indeling: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Nee	Dataset of map Toegestane waarden: `Dataset`, `TreeGroup` Standaard: `Dataset`

Response (201):

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: `uuid`
treeParentId	string	Ja	Indeling: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ja	Toegestane waarden: `Dataset`, `TreeGroup` Standaard: `Dataset`
displayName	string	Ja	Standaard: `""` Maximale lengte: 128
createdAt	string	Ja	Indeling: `date-time`
updatedAt	string	Ja	Indeling: `date-time`
dataTableId	string	Ja	Indeling: `uuid`

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen

Een dataset ophalen

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
datasetId	string	pad	Ja	Indeling: `uuid`

Response (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"
}

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: `uuid`
treeParentId	string	Ja	Indeling: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ja	Toegestane waarden: `Dataset`, `TreeGroup` Standaard: `Dataset`
displayName	string	Ja	Standaard: `""` Maximale lengte: 128
createdAt	string	Ja	Indeling: `date-time`
updatedAt	string	Ja	Indeling: `date-time`
dataTableId	string	Ja	Indeling: `uuid`

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Een dataset soft verwijderen

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
datasetId	string	pad	Ja	Indeling: `uuid`

Response (200):

Dataset verwijderd

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

Veld	Type	Verplicht	Beschrijving
success	boolean	Ja
message	string	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Datatabellen van een dataset weergeven

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
datasetId	string	pad	Ja	Indeling: `uuid`
limit	integer	query	Nee	Maximumaantal items in het resultaat
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met datatabellen in de dataset

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

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Een lege datatabel in een dataset maken

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
datasetId	string	pad	Ja	Indeling: `uuid`

Request body:

{
	"displayName": "string"
}

Veld	Type	Verplicht	Beschrijving
displayName	string	Ja	Naam van de datatabel Maximale lengte: 128

Response (201):

Aangemaakte datatabel

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: `uuid`
datasetId	string	Ja	Indeling: `uuid`
displayName	string	Ja	Standaard: `""` Maximale lengte: 128
createdAt	string	Ja	Indeling: `date-time`
updatedAt	string	Ja	Indeling: `date-time`
hasDataLoaded	boolean	Ja	Standaard: `false`
filterExpression	string	Ja	Maximale lengte: 4096
metaInfo	object \| object \| object \| object	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Datatabellen bevatten de event log-data die voor process mining wordt gebruikt.

Datatabellen weergeven

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
limit	integer	query	Nee	Maximumaantal items in het resultaat
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met datatabellen

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

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen

Een datatabel ophalen

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Response (200):

Datatabel

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: `uuid`
datasetId	string	Ja	Indeling: `uuid`
displayName	string	Ja	Standaard: `""` Maximale lengte: 128
createdAt	string	Ja	Indeling: `date-time`
updatedAt	string	Ja	Indeling: `date-time`
hasDataLoaded	boolean	Ja	Standaard: `false`
filterExpression	string	Ja	Maximale lengte: 4096
metaInfo	object \| object \| object \| object	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Een datatabel bijwerken (displayName, parseSettings, …)

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Naam van de datatabel Maximale lengte: 128
filterExpression	string	Nee	Filterexpressie die op de data wordt toegepast Maximale lengte: 4096

Response (200):

Bijgewerkte datatabel

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: `uuid`
datasetId	string	Ja	Indeling: `uuid`
displayName	string	Ja	Standaard: `""` Maximale lengte: 128
createdAt	string	Ja	Indeling: `date-time`
updatedAt	string	Ja	Indeling: `date-time`
hasDataLoaded	boolean	Ja	Standaard: `false`
filterExpression	string	Ja	Maximale lengte: 4096
metaInfo	object \| object \| object \| object	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Een ondertekende URL ophalen om het bronbestand van de datatabel te downloaden

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Response (200):

Download-URL

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

Veld	Type	Verplicht	Beschrijving
downloadUrl	string	Ja
expiresInSeconds	number	Ja

Fouten:

400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
404 Bron niet gevonden

Een multipart-upload afbreken en de geüploade delen verwijderen

Vereist de scope uploadData voor de API-sleutel.

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
uploadId	string	Ja
uploadHandle	string	Ja	Ondoorzichtige handle die bij het starten wordt teruggegeven

Response (200):

Afgebroken

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de tenant is inactief of het abonnement staat dit bestandstype niet toe
404 Bron niet gevonden

Een multipart-upload voltooien (stap 3 van 3)

Vereist de scope uploadData voor de API-sleutel. Voegt de geüploade delen samen (op basis van hun ETags) en start de verwerking van het event log.

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
uploadId	string	Ja
uploadHandle	string	Ja	Ondoorzichtige handle die bij het starten wordt teruggegeven
parts	object[]	Ja

Response (200):

Voltooid ({ completed: true })

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de tenant is inactief of het abonnement staat dit bestandstype niet toe
404 Bron niet gevonden

Een multipart-upload met delen starten voor event log-data (stap 1 van 3)

Vereist de scope uploadData voor de API-sleutel. Geeft een uploadId en een ondoorzichtige uploadHandle terug die je meestuurt met de volgende aanroepen: parts, complete en abort. Geschikt voor grote bestanden.

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
fileName	string	Ja
fileSize	number	Ja
fileLastModified	number	Ja
partCount	number	Nee	Aantal delen waarvoor een ondertekende URL wordt gemaakt (standaard 10)
delta	boolean	Nee	Geeft aan of dit een delta-upload (incrementele upload) is
datasetId	string	Nee	Indeling: `uuid`
modelId	string	Nee	Indeling: `uuid`

Response (200):

Upload gestart

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

Veld	Type	Verplicht	Beschrijving
uploadId	string	Nee
uploadHandle	string	Nee	Ondoorzichtige handle voor de stappen parts/complete/abort
partCount	number	Nee
partSizeBytes	number	Nee

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de tenant is inactief of het abonnement staat dit bestandstype niet toe
404 Bron niet gevonden

Ondertekende URL’s ophalen voor de delen van een multipart-upload (stap 2 van 3)

Vereist de scope uploadData voor de API-sleutel. Geeft voor elk aangevraagd deelnummer een ondertekende PUT-URL terug.

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

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`

Request body:

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

Veld	Type	Verplicht	Beschrijving
uploadId	string	Ja
uploadHandle	string	Ja	Ondoorzichtige handle die bij het starten wordt teruggegeven
partNumbers	number[]	Ja

Response (200):

Ondertekende URL’s voor delen ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de tenant is inactief of het abonnement staat dit bestandstype niet toe
404 Bron niet gevonden

Een ondertekende S3-upload-URL ophalen voor event log-data (CSV/XLSX, volledig of delta)

Vereist de scope uploadData op de API-sleutel, ongeacht lees- of schrijfrechten. De opgegeven filesize (bytes) wordt gecontroleerd op de maximale uploadgrootte van het platform. Zodra het bestand is aangekomen, wordt de werkelijke objectgrootte opnieuw gecontroleerd.

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

Authenticatie: Tenantgebonden API-sleutel · scope read

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: `uuid`
dataTableId	string	pad	Ja	Indeling: `uuid`
filename	string	query	Ja
filesize	string	query	Ja	Bestandsgrootte in bytes (gecontroleerd op de maximale uploadgrootte van het platform)
filelastmodified	string	query	Ja
datasetid	string	query	Nee	Vereist voor volledige uploads (geen delta)
modelid	string	query	Nee	Indeling: `uuid`
delta	`true` \| `false`	query	Nee	Toegestane waarden: `true`, `false`
partnumber	string	query	Nee
validforseconds	integer	query	Nee	Geldigheidsduur van de vooraf ondertekende URL in seconden (1–3600, standaard 3600)

Response (200):

Ondertekende URL

{
	"PreSignedUploadUrl": "string"
}

Veld	Type	Verplicht	Beschrijving
PreSignedUploadUrl	string	Ja	Ondertekende S3 PUT-URL (ongeveer 1 uur geldig)

Fouten:

401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
403 De API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement staat dit bestandstype niet toe
404 Bron niet gevonden
413 Bestand overschrijdt de maximale uploadgrootte van het platform

Gerelateerde documentatie

API-referentie: organisaties

API-referentie voor endpoints voor organisatiebeheer en gebruikersbeheer.

API-referentie: Tenants

API-referentie voor endpoints voor Tenant-beheer en toegangsbeheer voor gebruikers.

API-referentie: processen

API-referentie voor endpoints voor procesbeheer en datamapping.

API-referentie: simulaties

API-referentie voor het beheer van simulaties en endpoints voor AI-gestuurde generatie.

Verbeter processen. Bouw aan een samenhangende architectuur. Houd de regie.

Krijg meteen toegang, zonder creditcard of wachttijd. Maak van de manier waarop je organisatie werkt heldere, samenhangende procesmodellen.

Breng de procesarchitectuur in kaart, leg verantwoordelijkheden en beheersmaatregelen vast en stem rollen en taken op elk niveau op elkaar af.

Start je gratis proefperiode en bouw een betrouwbare basis om processen te beheren en continu te verbeteren.

Start vandaag je gratis proefperiode