Riferimento API: Data
Endpoint Dataset
I dataset sono insiemi di datatables correlate che appartengono logicamente allo stesso gruppo.
Elenco Dataset
Visualizza tutti i dataset di un tenant.
Endpoint: GET /tenant/{tenantId}/datasets
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
Risposta:
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
]
Crea Dataset
Crea un nuovo dataset all’interno del tenant.
Endpoint: POST /tenant/{tenantId}/datasets
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
Request Body:
{
"displayName": "My New Dataset",
"treeNodeType": "Dataset",
"treeParentId": null
}
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| displayName | string | Sì | Nome del dataset |
| treeNodeType | string | No | Deve essere Dataset (predefinito) o TreeGroup |
| treeParentId | string | No | ID della cartella parent per organizzare i dataset |
Risposta: Restituisce l’oggetto dataset creato.
Visualizza Dataset
Visualizza i dettagli di un dataset specifico.
Endpoint: GET /tenant/{tenantId}/datasets/{datasetId}
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
| datasetId | string | path | Sì | L’identificativo univoco del dataset |
Risposta:
{
"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
}
]
}
Elimina Dataset
Elimina un dataset e tutte le sue datatable.
Endpoint: DELETE /tenant/{tenantId}/datasets/{datasetId}
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
| datasetId | string | path | Sì | L’identificativo univoco del dataset |
Risposta:
{
"success": true
}
warning
Eliminando un dataset saranno rimossi in modo permanente tutti i datatable e i relativi dati. Questa azione non può essere annullata.
Endpoint Datatable
I datatable memorizzano i dati di event log utilizzati per il Process Mining.
Elenco Datatables
Visualizza tutte le datatables di un tenant.
Endpoint: GET /tenant/{tenantId}/datatables
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
Risposta:
[
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"createdAt": "2024-01-25T10:00:00Z"
}
]
Crea Datatable
Crea un nuovo datatable in un dataset esistente.
Endpoint: POST /tenant/{tenantId}/datasets/{datasetId}/datatables
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
| datasetId | string | path | Sì | L’identificativo univoco del dataset |
Request Body:
{
"displayName": "Orders Q1 2024"
}
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| displayName | string | Sì | Nome della datatable |
Risposta: Restituisce l’oggetto datatable creato.
Visualizza Datatable
Visualizza i dettagli di una datatable specifica.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
| datatableId | string | path | Sì | L’identificativo univoco della datatable |
Risposta:
{
"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"
}
Ottieni URL di Upload Presigned
Ottieni un URL temporaneo per caricare un file direttamente su una datatable.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | L’identificativo univoco del tenant |
| datatableId | string | path | Sì | L’identificativo univoco della datatable |
| datasetid | string | query | Sì | L’identificativo univoco del dataset |
| filename | string | query | Sì | Nome del file da caricare |
| filesize | string | query | Sì | Dimensione del file in byte |
| filelastmodified | string | query | Sì | Timestamp dell’ultima modifica del file |
| validforseconds | string | query | No | Durata validità URL in secondi (predefinito: 3600) |
Risposta:
{
"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}
Utilizzo: Usa l’URL fornito per caricare un file tramite HTTP PUT:
# Ottieni l'URL presigned con i parametri richiesti
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")
# Carica il file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"
info
Gli URL presigned scadono dopo un periodo limitato. Usa subito l’URL appena ottenuto. Se il caricamento non va a buon fine, richiedi un nuovo URL presigned.