API-Referenz: Organisationen
API-Referenz für Organisation und Endpunkte für die Benutzerverwaltung.
Datensets sind Sammlungen zusammengehöriger Datentables, die logisch verbunden sind.
Alle Datensets in einem Tenant abrufen.
Endpoint: GET /tenant/{tenantId}/Datensatzs
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
Response:
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
] Erstellt ein neues Datenset in einem Tenant.
Endpoint: POST /tenant/{tenantId}/Datensatzs
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
Request Body:
{
"displayName": "My New Dataset",
"treeNodeType": "Dataset",
"treeParentId": null
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Name des Datensets |
| treeNodeTyp | string | Nein | Muss Datenset (Standard) oder TreeGroup sein |
| treeParentId | string | Nein | Parent-Folder-ID zur Organisation von Datensets |
Response: Gibt das erstellte Datenset-Objekt zurück.
Details zu einem bestimmten Datenset abrufen.
Endpoint: GET /tenant/{tenantId}/Datensatzs/{DatensatzId}
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
| DatensatzId | string | path | Ja | Eindeutige Kennung des Datensets |
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
}
]
} Löscht ein Datenset samt aller zugehörigen Datentables.
Endpoint: DELETE /tenant/{tenantId}/Datensatzs/{DatensatzId}
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
| DatensatzId | string | path | Ja | Eindeutige Kennung des Datensets |
Response:
{
"success": true
} HINWEIS
Das Löschen eines Datensets entfernt alle verbundenen Datentables und Daten dauerhaft. Diese Aktion kann nicht rückgängig gemacht werden.
Datentables speichern die eigentlichen Event-Log-Daten, die für Process Mining geverwendet werden.
Alle Datentables in einem Tenant abrufen.
Endpoint: GET /tenant/{tenantId}/datatables
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
Response:
[
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"createdAt": "2024-01-25T10:00:00Z"
}
] Erstellt eine neue Datentable in einem vorhandenen Datenset.
Endpoint: POST /tenant/{tenantId}/Datensatzs/{DatensatzId}/datatables
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
| DatensatzId | string | path | Ja | Eindeutige Kennung des Datensets |
Request Body:
{
"displayName": "Orders Q1 2024"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Name der Datentable |
Response: Gibt das erstellte Datentable-Objekt zurück.
Details zu einer bestimmten Datentable abrufen.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
| datatableId | string | path | Ja | Eindeutige Kennung der Datentable |
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"
} Temporäre URL für den direkten Upload einer Datei in eine Datentable erhalten.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Eindeutige Kennung des Tenants |
| datatableId | string | path | Ja | Eindeutige Kennung der Datentable |
| Datensatzid | string | query | Ja | Eindeutige Kennung des Datensets |
| filename | string | query | Ja | Name der hochzuladenden Datei |
| filesize | string | query | Ja | Dateigröße in Bytes |
| filelastmodified | string | query | Ja | Zeitstempel der letzten Änderung der Datei |
| validforseconds | string | query | Nein | Gültigkeitsdauer der URL in Sekunden (Standard: 3600) |
Response:
{
"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
} Verwendung: Nutzen Sie die zurückgegebene URL, um eine Datei per HTTP PUT hochzuladen:
# Get the presigned URL with required 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 the file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL" Hinweis
Presigned URLs laufen nach kurzer Zeit ab. Nutzen Sie die URL zeitnah nach Erhalt. Falls der Upload fehlschlägt, fordern Sie eine neue presigned URL an.
Wir verwenden Cookies, um Ihr Nutzungserlebnis zu verbessern, personalisierte Inhalte anzuzeigen und die Nutzung unserer Website zu analysierenn. Mit Klick auf "Alle akzeptieren" stimmen Sie dem Einsatz von Cookies zu.