API-Referenz: Organisationen
API-Referenz für Endpunkte zur Organisationsverwaltung und Benutzerverwaltung.
warning
Beim Löschen eines Datasets werden alle zugehörigen Datentabellen und Daten dauerhaft entfernt. Diese Aktion 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
Signierte URLs laufen nach begrenzter Zeit ab. Verwenden Sie die URL unmittelbar nach dem Abruf. Wenn der Upload fehlschlägt, fordern Sie eine neue 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). Für Simulationsergebnisse wird immer das CSV-Format verwendet.
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
Die Datentabelle muss bereits über initial geladene Daten verfügen, bevor Delta-Uploads verwendet werden können. Die Delta-Datei muss dasselbe Format wie der ursprüngliche Upload verwenden, beispielsweise CSV-Delta für ein CSV-Original oder Parquet-Delta für ein Parquet-Original, und dieselbe Spaltenstruktur aufweisen. Excel- und XES-Dateien werden für Delta-Uploads nicht unterstützt.
info
Nach dem Upload über die 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, um zu erkennen, wann die Verarbeitung abgeschlossen ist.
Datasets sind Sammlungen logisch zusammengehöriger Datentabellen.
Endpunkt: GET /v1/tenant/{tenantId}/datasets
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| limit | integer | query | Nein | Maximale Anzahl zurückzugebender Elemente |
| offset | integer | query | Nein | Anzahl zu überspringender Elemente |
Antwort (200):
Liste der 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"
}
] Fehler:
Endpunkt: POST /v1/tenant/{tenantId}/datasets
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
Request Body:
{
"displayName": "string",
"treeParentId": "00000000-0000-0000-0000-000000000000",
"treeNodeType": "Dataset"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Im Datenbaum angezeigter Datensatzname 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):
Erstelltes 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"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| treeParentId | string | Ja | Format: uuid |
| treeNodeType | Dataset | TreeGroup | Ja | Zulässige Werte: Dataset, TreeGroupStandardwert: Dataset |
| displayName | string | Ja | Standardwert: ""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: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| datasetId | string | path | Ja | Format: uuid |
Antwort (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"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | Ja | Format: uuid |
| treeParentId | string | Ja | Format: uuid |
| treeNodeType | Dataset | TreeGroup | Ja | Zulässige Werte: Dataset, TreeGroupStandardwert: Dataset |
| displayName | string | Ja | Standardwert: ""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: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| datasetId | string | path | Ja | Format: uuid |
Antwort (200):
Dataset 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: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| datasetId | string | path | Ja | Format: uuid |
| limit | integer | query | Nein | Maximale Anzahl zurückzugebender Elemente |
| offset | integer | query | Nein | Anzahl zu überspringender Elemente |
Antwort (200):
Liste der Datentabellen im 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"
}
}
] Fehler:
Endpunkt: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| datasetId | string | path | Ja | Format: uuid |
Request Body:
{
"displayName": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| displayName | string | Ja | Name der Datentabelle Maximale Länge: 128 |
Antwort (201):
Erstellte 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 | Standardwert: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standardwert: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Datentabellen speichern die tatsächlichen Event-Log-Daten für Process Mining.
Endpunkt: GET /v1/tenant/{tenantId}/datatables
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| limit | integer | query | Nein | Maximale Anzahl zurückzugebender Elemente |
| offset | integer | query | Nein | Anzahl zu überspringender 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: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | 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 | Standardwert: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standardwert: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Endpunkt: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
Request Body:
{
"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):
Aktualisierte 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 | Standardwert: ""Maximale Länge: 128 |
| createdAt | string | Ja | Format: date-time |
| updatedAt | string | Ja | Format: date-time |
| hasDataLoaded | boolean | Ja | Standardwert: false |
| filterExpression | string | Ja | Maximale Länge: 4096 |
| metaInfo | object | object | object | object | Ja |
Fehler:
Endpunkt: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
Antwort (200):
Download-URL
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| downloadUrl | string | Ja | |
| expiresInSeconds | number | Ja |
Fehler:
Erfordert den Bereich uploadData für den API-Schlüssel.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
Request Body:
{
"uploadId": "string",
"uploadHandle": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | In der Initiierungsphase zurückgegebener undurchsichtiger Handle |
Antwort (200):
Abgebrochen
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Erfordert den Bereich uploadData für den API-Schlüssel. 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: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
Request Body:
{
"uploadId": "string",
"uploadHandle": "string",
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | In der Initiierungsphase zurückgegebener undurchsichtiger Handle |
| parts | object[] | Ja |
Antwort (200):
Abgeschlossen ({ completed: true })
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Erfordert den Bereich uploadData für den API-Schlüssel. Gibt eine uploadId und einen undurchsichtigen uploadHandle zurück, die an die nachfolgenden Aufrufe parts, complete und abort übergeben werden. Geeignet für große Dateien.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: 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"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| fileName | string | Ja | |
| fileSize | number | Ja | |
| fileLastModified | number | Ja | |
| partCount | number | Nein | Anzahl der zu signierenden Teile (Standardwert 10) |
| delta | boolean | Nein | Gibt an, ob es sich um einen Delta-Upload handelt |
| datasetId | string | Nein | Format: uuid |
| modelId | string | Nein | Format: uuid |
Antwort (200):
Upload initiiert
{
"uploadId": "string",
"uploadHandle": "string",
"partCount": 0,
"partSizeBytes": 0
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Nein | |
| uploadHandle | string | Nein | Undurchsichtiger Handle für die Schritte parts/complete/abort |
| partCount | number | Nein | |
| partSizeBytes | number | Nein |
Fehler:
Erfordert den Bereich uploadData für den API-Schlüssel. Gibt für jede angeforderte Teilenummer eine signierte PUT-URL zurück.
Endpunkt: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write
Parameter:
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Format: uuid |
| dataTableId | string | path | Ja | Format: uuid |
Request Body:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| uploadId | string | Ja | |
| uploadHandle | string | Ja | In der Initiierungsphase zurückgegebener undurchsichtiger Handle |
| partNumbers | number[] | Ja |
Antwort (200):
Signierte URLs für Teile ({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message | string | Ja |
Fehler:
Erfordert den Bereich uploadData für den API-Schlüssel, unabhängig von read/write. Die angegebene filesize in Bytes wird mit der maximalen Upload-Größe des Tarifs abgeglichen. Die tatsächliche Objektgröße wird erneut geprüft, sobald die Datei eingegangen ist.
Endpunkt: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url
Authentifizierung: Mandantengebundener API-Schlüssel · Bereich read
Parameter:
| Name | Typ | Position | 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, geprüft gegen die maximale Upload-Größe des Tarifs |
| filelastmodified | string | query | Ja | |
| datasetid | string | query | Nein | Für vollständige Uploads ohne Delta erforderlich |
| 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 signierten URL in Sekunden (1–3600, Standardwert 3600) |
Antwort (200):
Signierte URL
{
"PreSignedUploadUrl": "string"
} | Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| PreSignedUploadUrl | string | Ja | Signierte S3-PUT-URL (ca. 1 Stunde gültig) |
Fehler:
Wir verwenden Cookies, um Ihre Nutzererfahrung zu verbessern, Inhalte zu personalisieren und den Datenverkehr zu analysieren. Wenn Sie auf „Alle akzeptieren“ klicken, stimmen Sie der Verwendung von Cookies zu.