Auf dieser Seite

API-Referenz: Datenmanagement

Datenset Endpoints

Datensets sind Sammlungen zusammengehöriger Datentables, die logisch verbunden sind.

Datensets auflisten

Alle Datensets in einem Tenant abrufen.

Endpoint: GET /tenant/{tenantId}/Datensatzs

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants

Response:

[
	{
		"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"displayName": "Sales Data",
		"createdAt": "2024-01-20T08:00:00Z",
		"datatableCount": 3
	}
]

Datenset erstellen

Erstellt ein neues Datenset in einem Tenant.

Endpoint: POST /tenant/{tenantId}/Datensatzs

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants

Request Body:

{
	"displayName": "My New Dataset",
	"treeNodeType": "Dataset",
	"treeParentId": null
}
FeldTypErforderlichBeschreibung
displayNamestringJaName des Datensets
treeNodeTypstringNeinMuss Datenset (Standard) oder TreeGroup sein
treeParentIdstringNeinParent-Folder-ID zur Organisation von Datensets

Response: Gibt das erstellte Datenset-Objekt zurück.


Datenset abrufen

Details zu einem bestimmten Datenset abrufen.

Endpoint: GET /tenant/{tenantId}/Datensatzs/{DatensatzId}

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants
DatensatzIdstringpathJaEindeutige 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
		}
	]
}

Datenset löschen

Löscht ein Datenset samt aller zugehörigen Datentables.

Endpoint: DELETE /tenant/{tenantId}/Datensatzs/{DatensatzId}

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants
DatensatzIdstringpathJaEindeutige 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.


Datentable Endpoints

Datentables speichern die eigentlichen Event-Log-Daten, die für Process Mining geverwendet werden.

Datentables auflisten

Alle Datentables in einem Tenant abrufen.

Endpoint: GET /tenant/{tenantId}/datatables

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige 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"
	}
]

Datentable erstellen

Erstellt eine neue Datentable in einem vorhandenen Datenset.

Endpoint: POST /tenant/{tenantId}/Datensatzs/{DatensatzId}/datatables

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants
DatensatzIdstringpathJaEindeutige Kennung des Datensets

Request Body:

{
	"displayName": "Orders Q1 2024"
}
FeldTypErforderlichBeschreibung
displayNamestringJaName der Datentable

Response: Gibt das erstellte Datentable-Objekt zurück.


Datentable abrufen

Details zu einer bestimmten Datentable abrufen.

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants
datatableIdstringpathJaEindeutige 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"
}

Presigned Upload URL abrufen

Temporäre URL für den direkten Upload einer Datei in eine Datentable erhalten.

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl

Parameter:

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJaEindeutige Kennung des Tenants
datatableIdstringpathJaEindeutige Kennung der Datentable
DatensatzidstringqueryJaEindeutige Kennung des Datensets
filenamestringqueryJaName der hochzuladenden Datei
filesizestringqueryJaDateigröße in Bytes
filelastmodifiedstringqueryJaZeitstempel der letzten Änderung der Datei
validforsecondsstringqueryNeinGü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.