API-Referenz: Organisationen
API-Referenz für Endpunkte zur Verwaltung von Organisationen und Benutzern.
warning
Wenn Sie einen Datensatz löschen, werden alle zugehörigen Datentabellen und Daten dauerhaft entfernt. Dieser Vorgang kann nicht rückgängig gemacht werden.
Verwendung:
# 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
Vorab signierte URLs laufen nach einer begrenzten Zeit ab. Verwenden Sie die URL zeitnah nach dem Abruf. Schlägt der Upload fehl, fordern Sie eine neue vorab signierte URL an.
Verwendung:
# 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
Bei hochgeladenen Datentabellen bleibt das ursprüngliche Dateiformat erhalten (CSV, Parquet, ORC, JSONL oder Excel). Simulationsergebnisse liegen immer im CSV-Format vor.
Verwendung:
# 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
In die Datentabelle müssen bereits initiale Daten geladen worden sein, bevor Sie Delta-Uploads verwenden können. Die Delta-Datei muss dasselbe Format wie der ursprüngliche Upload haben, zum Beispiel ein CSV-Delta für eine ursprüngliche CSV-Datei oder ein Parquet-Delta für eine ursprüngliche Parquet-Datei. Auch die Spaltenstruktur muss übereinstimmen. Excel- und XES-Dateien werden für Delta-Uploads nicht unterstützt.
info
Nach dem Upload über die vorab signierte URL verarbeitet ProcessMind das Delta automatisch und führt es mit den ursprünglichen Daten zusammen. Fragen Sie GET /datatables/{dataTableId} ab, bis hasDataLoaded den Wert true hat. Dann ist die Verarbeitung abgeschlossen.
Datensätze enthalten zusammengehörige Datentabellen, die logisch eine Einheit bilden.
Endpunkt: GET /v1/tenant/{tenantId}/datasets
Authentifizierung: Mandantengebundener API-Schlüssel · Berechtigungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| limit | Ganzzahl | Abfrage | Nein | Maximale Anzahl zurückzugebender Elemente |
| offset | Ganzzahl | Abfrage | Nein | Anzahl der zu überspringenden Elemente |
Antwort (200):
Liste der Datensätze
[
{
"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"
}
] Fehler:
Endpunkt: POST /v1/tenant/{tenantId}/datasets
Authentifizierung: Mandantengebundener API-Schlüssel · Berechtigungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
Request-Body:
{
"displayName": "string",
"treeParentId": "00000000-0000-0000-0000-000000000000",
"treeNodeType": "Dataset"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Name des Datensatzes im Datenbaum Maximale Länge: 128 |
| treeParentId | string | Nein | ID des übergeordneten Ordners (null = oberste Ebene) Format: uuid |
| treeNodeType | Dataset | TreeGroup | Nein | Datensatz oder Ordner Zulässige Werte: Dataset, TreeGroupStandard: Dataset |
Antwort (201):
Erstellter Datensatz
{
"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"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| treeParentId | string | Ja | Format: uuid |
| treeNodeType | Dataset | TreeGroup | Ja | Zulässige Werte: Dataset, TreeGroupStandard: Dataset |
| displayName | string | Ja | Standard: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| dataTableId | string | Ja | Format: uuid |
Fehler:
Endpunkt: GET /v1/tenant/{tenantId}/datasets/{datasetId}
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| datasetId | string | Pfad | Ja | Format: uuid |
Antwort (200):
Datensatz
{
"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"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| treeParentId | string | Ja | Format: uuid |
| treeNodeType | Dataset | TreeGroup | Ja | Zulässige Werte: Dataset, TreeGroupStandard: Dataset |
| displayName | string | Ja | Standard: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| dataTableId | string | Ja | Format: uuid |
Fehler:
Endpunkt: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| datasetId | string | Pfad | Ja | Format: uuid |
Antwort (200):
Datensatz gelöscht
{
"success": true,
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| success | boolean | Ja | |
| message | string | Ja |
Fehler:
Endpunkt: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| datasetId | string | Pfad | Ja | Format: uuid |
| limit | integer | Abfrage | Nein | Maximale Anzahl der zurückzugebenden Elemente |
| offset | integer | Abfrage | Nein | Anzahl der zu überspringenden Elemente |
Antwort (200):
Liste der Datentabellen im Datensatz
[
{
"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"
}
}
] Fehler:
Endpunkt: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| datasetId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"displayName": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Name der Datentabelle Maximale Länge: 128 |
Antwort (201):
Datentabelle erstellt
{
"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"
}
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| datasetId | string | Ja | Format: uuid |
| displayName | string | Ja | Standard: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standard: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Datentabellen enthalten die Event-Log-Daten, die für Process Mining verwendet werden.
Endpunkt: GET /v1/tenant/{tenantId}/datatables
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| limit | integer | Abfrage | Nein | Maximale Anzahl der zurückzugebenden Elemente |
| offset | integer | Abfrage | Nein | Anzahl der zu überspringenden Elemente |
Antwort (200):
Liste der Datentabellen
[
{
"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"
}
}
] Fehler:
Endpunkt: GET /v1/tenant/{tenantId}/datatables/{dataTableId}
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Antwort (200):
Datentabelle
{
"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"
}
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| datasetId | string | Ja | Format: uuid |
| displayName | string | Ja | Standard: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standard: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Endpunkt: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"displayName": "string",
"filterExpression": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Nein | Name der Datentabelle Maximale Länge: 128 |
| filterExpression | string | Nein | Auf die Daten angewendeter Filterausdruck Maximale Länge: 4096 |
Antwort (200):
Datentabelle aktualisiert
{
"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"
}
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| datasetId | string | Ja | Format: uuid |
| displayName | string | Ja | Standard: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standard: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Endpunkt: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Antwort (200):
Download-URL
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| downloadUrl | string | Ja | |
| expiresInSeconds | number | Ja |
Fehler:
Für den API-Schlüssel ist der Geltungsbereich uploadData erforderlich.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"uploadId": "string",
"uploadHandle": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | Nicht transparenter Handle aus dem Initiierungsschritt |
Antwort (200):
Abgebrochen
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Für den API-Schlüssel ist der Geltungsbereich uploadData erforderlich. Fügt die hochgeladenen Teile anhand ihrer ETags zusammen und startet die Verarbeitung des Event Logs.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"uploadId": "string",
"uploadHandle": "string",
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | Nicht transparenter Handle aus dem Initiierungsschritt |
| parts | object[] | Ja |
Antwort (200):
Abgeschlossen ({ completed: true })
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Für den API-Schlüssel ist der Geltungsbereich uploadData erforderlich. Gibt eine uploadId und einen nicht transparenten uploadHandle zurück, die bei den folgenden Aufrufen parts, complete und abort übergeben werden. Geeignet für große Dateien.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"fileName": "string",
"fileSize": 0,
"fileLastModified": 0,
"partCount": 0,
"delta": true,
"datasetId": "00000000-0000-0000-0000-000000000000",
"modelId": "00000000-0000-0000-0000-000000000000"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| fileName | string | Ja | |
| fileSize | number | Ja | |
| fileLastModified | number | Ja | |
| partCount | number | Nein | Anzahl der vorab zu signierenden Teile (Standard: 10) |
| delta | boolean | Nein | Gibt an, ob es sich um einen Delta-Upload (inkrementellen Upload) handelt |
| datasetId | string | Nein | Format: uuid |
| modelId | string | Nein | Format: uuid |
Antwort (200):
Upload gestartet
{
"uploadId": "string",
"uploadHandle": "string",
"partCount": 0,
"partSizeBytes": 0
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Nein | |
| uploadHandle | string | Nein | Nicht transparenter Handle für die Schritte zum Hochladen der Teile, Abschließen und Abbrechen |
| partCount | number | Nein | |
| partSizeBytes | number | Nein |
Fehler:
Für den API-Schlüssel ist der Geltungsbereich uploadData erforderlich. Gibt für jede angeforderte Teilenummer eine vorab signierte PUT-URL zurück.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich write
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | Format: uuid |
| dataTableId | string | Pfad | Ja | Format: uuid |
Anfragetext:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | Nicht transparenter Handle aus dem Initiierungsschritt |
| partNumbers | number[] | Ja |
Antwort (200):
Vorab signierte URLs für Teile ({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Erfordert den Scope uploadData für den API-Schlüssel, unabhängig von Lese- und Schreibrechten. Die angegebene Größe filesize in Bytes wird mit der maximalen Upload-Größe der Plattform verglichen. Sobald die Datei eingegangen ist, wird die tatsächliche Objektgröße erneut geprüft.
Endpunkt: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url
Authentifizierung: Mandantenbezogener API-Schlüssel · Geltungsbereich read
Parameter:
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
| filename | string | query | Ja | |
| filesize | string | query | Ja | Dateigröße in Bytes (wird mit der maximalen Upload-Größe der Plattform verglichen) |
| filelastmodified | string | query | Ja | |
| datasetid | string | query | Nein | Erforderlich für vollständige Uploads (keine Delta-Uploads) |
| modelid | string | query | Nein | Format: uuid |
| delta | true | false | query | Nein | Zulässige Werte: true, false |
| partnumber | string | query | Nein | |
| validforseconds | integer | query | Nein | Gültigkeitsdauer der vorab signierten URL in Sekunden (1–3600, Standardwert 3600) |
Antwort (200):
Vorab signierte URL
{
"PreSignedUploadUrl": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| PreSignedUploadUrl | string | Ja | Vorab signierte S3-PUT-URL (ca. 1 Stunde gültig) |
Fehler:
Erhalten Sie sofort Zugriff, ohne Kreditkarte und Wartezeit. Bilden Sie die Arbeitsweise Ihrer Organisation in klaren, vernetzten Prozessmodellen ab.
Entwickeln Sie Ihre Prozessarchitektur, definieren Sie Zuständigkeiten und Kontrollen und stimmen Sie Rollen und Verantwortlichkeiten auf allen Ebenen ab.
Starten Sie Ihre kostenlose Testphase und schaffen Sie eine verlässliche Grundlage, um Ihre Prozesse zu steuern und kontinuierlich zu verbessern.
Wir verwenden Cookies, um Ihre Nutzungserfahrung zu verbessern, Inhalte zu personalisieren und den Datenverkehr zu analysieren. Anonyme Seitenaufrufe werden auch ohne Cookies erfasst. Wenn Sie der Analyse zustimmen, wird eine Kennung gesetzt, mit der Ihre Besuche verknüpft werden. Wenn Sie auf "Alle akzeptieren" klicken, stimmen Sie der Verwendung von Cookies zu.