In questa pagina

> risorse > documentazione > api > Riferimento API: dati

Riferimento API: dati

warning

L’eliminazione di un dataset rimuove definitivamente tutte le tabelle dati e i dati associati. Questa azione non può essere annullata.

Utilizzo:

# 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

Gli URL presigned scadono dopo un periodo limitato. Utilizzi l’URL subito dopo averlo ottenuto. Se il caricamento non riesce, richieda un nuovo URL presigned.

Utilizzo:

# 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

Per le tabelle dati caricate viene mantenuto il formato originale del file (CSV, Parquet, ORC, JSONL o Excel). Per i risultati della simulazione, il file è sempre in formato CSV.

Utilizzo:

# 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

La tabella dati deve contenere dati iniziali già caricati prima di poter utilizzare i caricamenti delta. Il file delta deve usare lo stesso formato del caricamento originale, ad esempio delta CSV per un originale CSV e delta Parquet per un originale Parquet, e deve avere la stessa struttura delle colonne. I file Excel e XES non sono supportati per i caricamenti delta.

info

Dopo il caricamento tramite l’URL presigned, ProcessMind elabora automaticamente il delta e lo combina con i dati originali. Verifichi GET /datatables/{dataTableId} finché hasDataLoaded non è true per sapere quando l’elaborazione è terminata.

I dataset sono raccolte di tabelle dati correlate che appartengono logicamente allo stesso insieme.

Elencare i dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
limit	integer	query	No	Numero massimo di elementi da restituire
offset	integer	query	No	Numero di elementi da ignorare

Risposta (200):

Elenco dei 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"
	}
]

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta

Creare un dataset (con una tabella dati vuota)

Endpoint: POST /v1/tenant/{tenantId}/datasets

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	Sì	Nome del dataset visualizzato nell’albero dei dati Lunghezza massima: 128
treeParentId	string	No	ID della cartella principale (null = livello superiore) Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	No	Dataset o cartella Valori consentiti: `Dataset`, `TreeGroup` Predefinito: `Dataset`

Risposta (201):

Dataset creato

{
	"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"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
treeParentId	string	Sì	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sì	Valori consentiti: `Dataset`, `TreeGroup` Predefinito: `Dataset`
displayName	string	Sì	Predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
dataTableId	string	Sì	Formato: `uuid`

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta

Recuperare un dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
datasetId	string	path	Sì	Formato: `uuid`

Risposta (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"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
treeParentId	string	Sì	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sì	Valori consentiti: `Dataset`, `TreeGroup` Predefinito: `Dataset`
displayName	string	Sì	Predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
dataTableId	string	Sì	Formato: `uuid`

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Eliminare logicamente un dataset

Endpoint: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
datasetId	string	path	Sì	Formato: `uuid`

Risposta (200):

Dataset eliminato

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
success	boolean	Sì
message	string	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Elencare le tabelle dati di un dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
datasetId	string	path	Sì	Formato: `uuid`
limit	integer	query	No	Numero massimo di elementi da restituire
offset	integer	query	No	Numero di elementi da ignorare

Risposta (200):

Elenco delle tabelle dati nel 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"
		}
	}
]

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Creare una tabella dati vuota all’interno di un dataset

Endpoint: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
datasetId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"displayName": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	Sì	Nome della tabella dati Lunghezza massima: 128

Risposta (201):

Tabella dati creata

{
	"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"
	}
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
datasetId	string	Sì	Formato: `uuid`
displayName	string	Sì	Predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Predefinito: `false`
filterExpression	string	Sì	Lunghezza massima: 4096
metaInfo	object \| object \| object \| object	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Le tabelle dati contengono i dati effettivi dell’Event Log utilizzati per il Process Mining.

Elencare le tabelle dati

Endpoint: GET /v1/tenant/{tenantId}/datatables

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
limit	integer	query	No	Numero massimo di elementi da restituire
offset	integer	query	No	Numero di elementi da ignorare

Risposta (200):

Elenco delle tabelle dati

[
	{
		"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"
		}
	}
]

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta

Recuperare una tabella dati

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Risposta (200):

Tabella dati

{
	"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"
	}
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
datasetId	string	Sì	Formato: `uuid`
displayName	string	Sì	Predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Predefinito: `false`
filterExpression	string	Sì	Lunghezza massima: 4096
metaInfo	object \| object \| object \| object	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Aggiornare una tabella dati (displayName, parseSettings, …)

Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"displayName": "string",
	"filterExpression": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Nome della tabella dati Lunghezza massima: 128
filterExpression	string	No	Espressione di filtro applicata ai dati Lunghezza massima: 4096

Risposta (200):

Tabella dati aggiornata

{
	"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"
	}
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
datasetId	string	Sì	Formato: `uuid`
displayName	string	Sì	Predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Predefinito: `false`
filterExpression	string	Sì	Lunghezza massima: 4096
metaInfo	object \| object \| object \| object	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Ottenere un URL presigned per scaricare il file sorgente della tabella dati

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Risposta (200):

URL di download

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}

Campo	Tipo	Obbligatorio	Descrizione
downloadUrl	string	Sì
expiresInSeconds	number	Sì

Errori:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un tipo di caricamento non supportato o un campo obbligatorio mancante
401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Annullare un caricamento multipart e scartare le parti caricate

Richiede l’ambito uploadData sulla chiave API.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"uploadId": "string",
	"uploadHandle": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	Sì
uploadHandle	string	Sì	Handle opaco restituito dal passaggio di avvio

Risposta (200):

Annullato

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il tenant è inattivo oppure il piano blocca il tipo di file
404 Risorsa non trovata

Completare un caricamento multipart (passaggio 3 di 3)

Richiede l’ambito uploadData sulla chiave API. Riunisce le parti caricate, utilizzando i relativi ETag, e avvia l’elaborazione dell’Event Log.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	Sì
uploadHandle	string	Sì	Handle opaco restituito dal passaggio di avvio
parts	object[]	Sì

Risposta (200):

Completato ({ completed: true })

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il tenant è inattivo oppure il piano blocca il tipo di file
404 Risorsa non trovata

Avviare un caricamento multipart (a blocchi) per i dati dell’Event Log (passaggio 1 di 3)

Richiede l’ambito uploadData sulla chiave API. Restituisce un uploadId e un uploadHandle opaco da passare alle chiamate parts, complete e abort successive. È adatto ai file di grandi dimensioni.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
fileName	string	Sì
fileSize	number	Sì
fileLastModified	number	Sì
partCount	number	No	Numero di parti per cui generare URL presigned (predefinito 10)
delta	boolean	No	Indica se si tratta di un caricamento delta (incrementale)
datasetId	string	No	Formato: `uuid`
modelId	string	No	Formato: `uuid`

Risposta (200):

Caricamento avviato

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	No
uploadHandle	string	No	Handle opaco per i passaggi parts/complete/abort
partCount	number	No
partSizeBytes	number	No

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il tenant è inattivo oppure il piano blocca il tipo di file
404 Risorsa non trovata

Ottenere gli URL presigned per le parti di un caricamento multipart (passaggio 2 di 3)

Richiede l’ambito uploadData sulla chiave API. Restituisce un URL PUT presigned per ogni numero di parte richiesto.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Autenticazione: chiave API associata al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`

Corpo della richiesta:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	Sì
uploadHandle	string	Sì	Handle opaco restituito dal passaggio di avvio
partNumbers	number[]	Sì

Risposta (200):

URL presigned delle parti ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il tenant è inattivo oppure il piano blocca il tipo di file
404 Risorsa non trovata

Ottenere un URL di caricamento S3 presigned per i dati dell’Event Log (CSV/XLSX, completo o delta)

Richiede l’ambito uploadData sulla chiave API, indipendentemente dagli ambiti read/write. Il valore dichiarato di filesize, espresso in byte, viene verificato rispetto alla dimensione massima di caricamento prevista dal piano; la dimensione effettiva dell’oggetto viene verificata nuovamente quando il file arriva.

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Autenticazione: chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: `uuid`
dataTableId	string	path	Sì	Formato: `uuid`
filename	string	query	Sì
filesize	string	query	Sì	Dimensione del file in byte, verificata rispetto alla dimensione massima di caricamento prevista dal piano
filelastmodified	string	query	Sì
datasetid	string	query	No	Obbligatorio per i caricamenti completi, non delta
modelid	string	query	No	Formato: `uuid`
delta	`true` \| `false`	query	No	Valori consentiti: `true`, `false`
partnumber	string	query	No
validforseconds	integer	query	No	Durata dell’URL presigned in secondi (1–3600, predefinita 3600)

Risposta (200):

URL presigned

{
	"PreSignedUploadUrl": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
PreSignedUploadUrl	string	Sì	URL PUT S3 presigned, valido per circa un’ora

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il tenant è inattivo oppure il piano blocca il tipo di file
404 Risorsa non trovata
413 Il file supera la dimensione massima di caricamento prevista dal piano

Documentazione correlata

Riferimento API: organizzazioni

Riferimento API per la gestione delle organizzazioni e gli endpoint di amministrazione degli utenti.

Riferimento API: tenant

Riferimento API per gli endpoint di gestione dei tenant e controllo degli accessi degli utenti.

Riferimento API: processi

Riferimento API per la gestione dei processi e gli endpoint di mappatura dei dati.

Riferimento API: Simulazioni

Riferimento API per la gestione delle simulazioni e gli endpoint di generazione basati su AI.

Riferimento API: dati

Elencare i dataset

Creare un dataset (con una tabella dati vuota)

Recuperare un dataset

Eliminare logicamente un dataset

Elencare le tabelle dati di un dataset

Creare una tabella dati vuota all’interno di un dataset

Elencare le tabelle dati

Recuperare una tabella dati

Aggiornare una tabella dati (displayName, parseSettings, …)

Ottenere un URL presigned per scaricare il file sorgente della tabella dati

Annullare un caricamento multipart e scartare le parti caricate

Completare un caricamento multipart (passaggio 3 di 3)

Avviare un caricamento multipart (a blocchi) per i dati dell’Event Log (passaggio 1 di 3)

Ottenere gli URL presigned per le parti di un caricamento multipart (passaggio 2 di 3)

Ottenere un URL di caricamento S3 presigned per i dati dell’Event Log (CSV/XLSX, completo o delta)

Documentazione correlata

Riferimento API: organizzazioni

Riferimento API: tenant

Riferimento API: processi

Riferimento API: Simulazioni

La Sua privacy è importante