API Referentie: Organisaties
API-referentie voor organisatiebeheer en gebruikersbeheer endpoints.
Op deze pagina
API Referentie: Data
Dataset Endpoints
Datasets zijn groepen van samenhangende datatables die logisch bij elkaar horen.
List Datasets
Haal alle datasets binnen een tenant op.
Endpoint: GET /tenant/{tenantId}/datasets
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
Response:
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
]
Create Dataset
Maak een nieuwe dataset aan binnen een tenant.
Endpoint: POST /tenant/{tenantId}/datasets
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
Request Body:
{
"displayName": "Mijn nieuwe Dataset",
"treeNodeType": "Dataset",
"treeParentId": null
}
| Veld | Type | Verplicht | Omschrijving |
|---|---|---|---|
| displayName | string | Ja | Naam van de dataset |
| treeNodeType | string | Nee | Moet Dataset (standaard) of TreeGroup zijn |
| treeParentId | string | Nee | ID van de bovenliggende map voor datasets |
Response: Geeft het aangemaakte dataset object terug.
Get Dataset
Haal details op van een specifieke dataset.
Endpoint: GET /tenant/{tenantId}/datasets/{datasetId}
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
| datasetId | string | path | Ja | De unieke identifier van de dataset |
Response:
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatables": [
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders",
"rowCount": 15000
}
]
}
Delete Dataset
Verwijder een dataset en alle gekoppelde datatables.
Endpoint: DELETE /tenant/{tenantId}/datasets/{datasetId}
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
| datasetId | string | path | Ja | De unieke identifier van de dataset |
Response:
{
"success": true
}
warning
Let op: het verwijderen van een dataset verwijdert permanent alle gekoppelde datatables en data. Deze actie kan niet ongedaan gemaakt worden.
Datatable Endpoints
Datatables bevatten de echte event log data die gebruikt wordt voor Process Mining.
List Datatables
Haal alle datatables binnen een tenant op.
Endpoint: GET /tenant/{tenantId}/datatables
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
Response:
[
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"createdAt": "2024-01-25T10:00:00Z"
}
]
Create Datatable
Maak een nieuwe datatable aan binnen een bestaande dataset.
Endpoint: POST /tenant/{tenantId}/datasets/{datasetId}/datatables
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
| datasetId | string | path | Ja | De unieke identifier van de dataset |
Request Body:
{
"displayName": "Orders Q1 2024"
}
| Veld | Type | Verplicht | Omschrijving |
|---|---|---|---|
| displayName | string | Ja | Naam van de datatable |
Response: Geeft het aangemaakte datatable object terug.
Get Datatable
Haal details op van een specifieke datatable.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
| datatableId | string | path | Ja | De unieke identifier van de datatable |
Response:
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"columns": [
{"name": "case_id", "type": "string"},
{"name": "activity", "type": "string"},
{"name": "timestamp", "type": "datetime"}
],
"createdAt": "2024-01-25T10:00:00Z"
}
Get Presigned Upload URL
Haal een tijdelijke URL op om een bestand direct naar een datatable te uploaden.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parameters:
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke identifier van de tenant |
| datatableId | string | path | Ja | De unieke identifier van de datatable |
| datasetid | string | query | Ja | De unieke identifier van de dataset |
| filename | string | query | Ja | De naam van het te uploaden bestand |
| filesize | string | query | Ja | Grootte van het bestand in bytes |
| filelastmodified | string | query | Ja | Tijdstip waarop het bestand voor het laatst is aangepast |
| validforseconds | string | query | Nee | Geldigheid van de URL in seconden (standaard: 3600) |
Response:
{
"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}
Gebruik: Gebruik de opgehaalde URL om via HTTP PUT een bestand te uploaden:
# Haal de presigned URL op met de benodigde parameters
URL=$(curl -s -H "X-API-Key: your-api-key" \
"https://api.processmind.com/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")
# Upload het bestand
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"
info
Presigned URLs zijn maar tijdelijk geldig. Gebruik de URL direct na ontvangst. Gaat de upload fout, vraag dan een nieuwe presigned URL aan.