API-referentie: organisaties
API-referentie voor endpoints voor organisatiebeheer en gebruikersbeheer.
warning
Als je een dataset verwijdert, worden alle bijbehorende datatables en data permanent 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
Presigned URL’s verlopen na een beperkte tijd. Gebruik de URL meteen nadat je die hebt ontvangen. Als de upload mislukt, vraag je een nieuwe presigned 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 datatables blijft de oorspronkelijke bestandsindeling behouden (CSV, Parquet, ORC, JSONL of Excel). Voor simulatieresultaten is het bestand altijd in CSV-indeling.
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
De datatable moet al initiële data bevatten voordat je delta-uploads kunt gebruiken. Het delta-bestand moet dezelfde indeling hebben als de oorspronkelijke upload, bijvoorbeeld CSV-delta voor een oorspronkelijk CSV-bestand en Parquet-delta voor een oorspronkelijk Parquet-bestand, en dezelfde kolomstructuur hebben. Excel- en XES-bestanden worden niet ondersteund voor delta-uploads.
info
Na de upload via de presigned URL verwerkt ProcessMind de delta automatisch en voegt die samen met de oorspronkelijke data. Vraag GET /datatables/{dataTableId} herhaaldelijk op totdat hasDataLoaded true is, om te zien wanneer de verwerking klaar is.
Datasets zijn verzamelingen van logisch bij elkaar horende datatables.
Endpoint: GET /v1/tenant/{tenantId}/datasets
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| limit | integer | query | Nee | Maximumaantal items dat wordt teruggegeven |
| 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:
Endpoint: POST /v1/tenant/{tenantId}/datasets
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
Request body:
{
"displayName": "string",
"treeParentId": "00000000-0000-0000-0000-000000000000",
"treeNodeType": "Dataset"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| displayName | string | Ja | Datasetnaam die in de datastructuur wordt weergegeven Maximale lengte: 128 |
| treeParentId | string | Nee | ID van de bovenliggende map (null = hoofdniveau) Indeling: uuid |
| treeNodeType | Dataset | TreeGroup | Nee | Dataset of map Toegestane waarden: Dataset, TreeGroupStandaard: 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, TreeGroupStandaard: 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:
Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| datasetId | string | path | 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, TreeGroupStandaard: 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:
Endpoint: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| datasetId | string | path | Ja | Indeling: uuid |
Response (200):
Dataset verwijderd
{
"success": true,
"message": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| success | boolean | Ja | |
| message | string | Ja |
Fouten:
Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| datasetId | string | path | Ja | Indeling: uuid |
| limit | integer | query | Nee | Maximumaantal items dat wordt teruggegeven |
| offset | integer | query | Nee | Aantal over te slaan items |
Response (200):
Lijst met datatables 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:
Endpoint: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| datasetId | string | path | Ja | Indeling: uuid |
Request body:
{
"displayName": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| displayName | string | Ja | Naam van de datatable Maximale lengte: 128 |
Response (201):
Aangemaakte datatable
{
"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:
Datatables bevatten de daadwerkelijke event log-data die voor process mining wordt gebruikt.
Endpoint: GET /v1/tenant/{tenantId}/datatables
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| limit | integer | query | Nee | Maximumaantal items dat wordt teruggegeven |
| offset | integer | query | Nee | Aantal over te slaan items |
Response (200):
Lijst met datatables
[
{
"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:
Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
Response (200):
Datatable
{
"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:
Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
Request body:
{
"displayName": "string",
"filterExpression": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| displayName | string | Nee | Naam van de datatable Maximale lengte: 128 |
| filterExpression | string | Nee | Filterexpressie die op de data wordt toegepast Maximale lengte: 4096 |
Response (200):
Bijgewerkte datatable
{
"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:
Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
Authenticatie: Tenantgebonden API-sleutel · scope read
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
Response (200):
Download-URL
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| downloadUrl | string | Ja | |
| expiresInSeconds | number | Ja |
Fouten:
Hiervoor is de scope uploadData op de API-sleutel vereist.
Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
Request body:
{
"uploadId": "string",
"uploadHandle": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | Ondoorzichtige handle die door de initiatiestap wordt teruggegeven |
Response (200):
Afgebroken
{
"message": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| message | string | Ja |
Fouten:
Hiervoor is de scope uploadData op de API-sleutel vereist. De geüploade delen worden samengevoegd op basis van hun ETags, waarna de verwerking van het event log wordt gestart.
Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | 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 door de initiatiestap wordt teruggegeven |
| parts | object[] | Ja |
Response (200):
Voltooid ({ completed: true })
{
"message": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| message | string | Ja |
Fouten:
Hiervoor is de scope uploadData op de API-sleutel vereist. De response bevat een uploadId en een ondoorzichtige uploadHandle die je moet doorgeven aan de daaropvolgende 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 | path | Ja | Indeling: uuid |
| dataTableId | string | path | 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 presigned URL wordt aangemaakt (standaard 10) |
| delta | boolean | Nee | Of dit een delta- of 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:
Hiervoor is de scope uploadData op de API-sleutel vereist. De response bevat één presigned PUT-URL per aangevraagd deelnummer.
Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
Authenticatie: Tenantgebonden API-sleutel · scope write
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
Request body:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | Ondoorzichtige handle die door de initiatiestap wordt teruggegeven |
| partNumbers | number[] | Ja |
Response (200):
Presigned URL’s voor delen ({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| message | string | Ja |
Fouten:
Hiervoor is de scope uploadData op de API-sleutel vereist, onafhankelijk van read/write. De opgegeven filesize in bytes wordt gecontroleerd tegen de maximale uploadgrootte van het abonnement. Zodra het bestand is geüpload, 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 | path | Ja | Indeling: uuid |
| dataTableId | string | path | Ja | Indeling: uuid |
| filename | string | query | Ja | |
| filesize | string | query | Ja | Bestandsgrootte in bytes, gecontroleerd tegen de maximale uploadgrootte van het abonnement |
| filelastmodified | string | query | Ja | |
| datasetid | string | query | Nee | Vereist voor volledige uploads, dus niet voor delta-uploads |
| 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 presigned URL in seconden (1–3600, standaard 3600) |
Response (200):
Presigned URL
{
"PreSignedUploadUrl": "string"
} | Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| PreSignedUploadUrl | string | Ja | Presigned S3 PUT-URL, ongeveer 1 uur geldig |
Fouten:
We gebruiken cookies om je ervaring te verbeteren, content te personaliseren en verkeer te analyseren. Door op "Alles accepteren" te klikken, geef je toestemming voor ons gebruik van cookies.