In questa pagina

> risorse > documentazione > api > Documentazione di riferimento dell’API: dati

Documentazione di riferimento dell’API: dati

warning

L’eliminazione di un dataset rimuove definitivamente tutte le tabelle dati e i dati associati. Non è possibile annullare questa operazione.

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 prefirmati scadono dopo un intervallo di tempo limitato. Utilizzi l’URL subito dopo averlo ottenuto. Se il caricamento non riesce, richieda un nuovo URL prefirmato.

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 del file originale (CSV, Parquet, ORC, JSONL o Excel). I risultati della simulazione sono 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

Prima di poter caricare dati incrementali, la tabella dati deve contenere dati iniziali. Il file incrementale deve avere lo stesso formato del file originale, ad esempio un file CSV incrementale per un originale CSV o un file Parquet incrementale per un originale Parquet, e la stessa struttura di colonne. I caricamenti incrementali non supportano file Excel e XES.

info

Dopo il caricamento tramite l’URL prefirmato, ProcessMind elabora automaticamente i dati incrementali e li combina con i dati originali. Interroghi GET /datatables/{dataTableId} finché hasDataLoaded non è true per verificare che l’elaborazione sia terminata.

I dataset sono raccolte di tabelle dati correlate, raggruppate secondo una logica comune.

Elencare i dataset

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

Autenticazione: chiave API con ambito limitato al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	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 con ambito limitato al tenant · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	Sì	Nome dell’insieme di dati visualizzato nell’albero dei dati Lunghezza massima: 128
treeParentId	string	No	ID della cartella principale (null = livello superiore) Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	No	Insieme di dati 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` Valore predefinito: `Dataset`
displayName	string	Sì	Valore 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	percorso	Sì	Formato: `uuid`
datasetId	string	percorso	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` Valore predefinito: `Dataset`
displayName	string	Sì	Valore 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	percorso	Sì	Formato: `uuid`
datasetId	string	percorso	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	percorso	Sì	Formato: `uuid`
datasetId	string	percorso	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	percorso	Sì	Formato: `uuid`
datasetId	string	percorso	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ì	Valore predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Valore 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	percorso	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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	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ì	Valore predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Valore 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	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ì	Valore predefinito: `""` Lunghezza massima: 128
createdAt	string	Sì	Formato: `date-time`
updatedAt	string	Sì	Formato: `date-time`
hasDataLoaded	boolean	Sì	Valore 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 firmato 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	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, espressione di filtro non valida, processo senza modello, tipo di caricamento non supportato o campo obbligatorio mancante
401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Annullare un caricamento multipart ed eliminare le parti caricate

Richiede l’ambito uploadData per la 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	Sì	Formato: `uuid`

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	Sì
uploadHandle	string	Sì	Identificatore opaco restituito nella fase di avvio

Risposta (200):

Operazione annullata

{
	"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 non consente questo tipo di file
404 Risorsa non trovata

Completare un caricamento multipart (fase 3 di 3)

Richiede l’ambito uploadData per la chiave API. Assembla 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	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ì	Identificatore opaco restituito nella fase 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 non consente questo tipo di file
404 Risorsa non trovata

Avviare un caricamento multipart (suddiviso in parti) dei dati dell’Event Log (fase 1 di 3)

Richiede l’ambito uploadData per la chiave API. Restituisce un uploadId e un uploadHandle identificatore opaco da passare alle chiamate successive parts, complete e abort. 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	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 firmati (predefinito: 10)
delta	boolean	No	Indica se si tratta di un caricamento incrementale (delta)
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	Identificatore opaco per le fasi di caricamento delle parti, completamento e annullamento
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 non consente questo tipo di file
404 Risorsa non trovata

Ottenere URL firmati per le parti di un caricamento multipart (fase 2 di 3)

Richiede l’ambito uploadData per la chiave API. Restituisce un URL PUT firmato 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	percorso	Sì	Formato: `uuid`
dataTableId	string	percorso	Sì	Formato: `uuid`

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
uploadId	string	Sì
uploadHandle	string	Sì	Identificatore opaco restituito nella fase di avvio
partNumbers	number[]	Sì

Risposta (200):

URL firmati 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 non consente questo tipo di file
404 Risorsa non trovata

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

Richiede l’ambito uploadData per la chiave API, indipendentemente dai permessi di lettura o scrittura. Il valore dichiarato di filesize (byte) viene confrontato con la dimensione massima di caricamento consentita dalla piattaforma; quando il file viene ricevuto, la dimensione effettiva dell’oggetto viene verificata nuovamente.

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 (confrontata con la dimensione massima di caricamento consentita dalla piattaforma)
filelastmodified	string	query	Sì
datasetid	string	query	No	Obbligatorio per i caricamenti completi (non incrementali)
modelid	string	query	No	Formato: `uuid`
delta	`true` \| `false`	query	No	Valori consentiti: `true`, `false`
partnumber	string	query	No
validforseconds	integer	query	No	Durata di validità dell’URL presigned, in secondi (1–3600, valore predefinito 3600)

Risposta (200):

URL firmato

{
	"PreSignedUploadUrl": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
PreSignedUploadUrl	string	Sì	URL PUT S3 firmato (valido per circa un’ora)

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
403 La chiave API non dispone dell’ambito o dell’accesso all’organizzazione richiesti, il tenant è inattivo oppure il piano non consente questo tipo di file
404 Risorsa non trovata
413 Il file supera la dimensione massima di caricamento consentita dalla piattaforma

Documentazione correlata

Riferimento API: organizzazioni

Riferimento API per gli endpoint di gestione delle organizzazioni e 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 gli endpoint di gestione dei processi e mappatura dei dati.

Riferimento API: simulazioni

Riferimento API per gli endpoint di gestione delle simulazioni e generazione assistita dall’AI.

Progettazione. Analisi. Miglioramento. Costruisca un’architettura dei processi integrata e mantenga il controllo.

Acceda subito, senza carta di credito né attese. Trasformi il modo in cui opera la Sua organizzazione in una progettazione dei processi chiara e interconnessa.

Definisca l’architettura dei processi, le responsabilità e i controlli, e allinei ruoli e compiti a ogni livello.

Inizi la prova gratuita e crei una base affidabile per governare, gestire e migliorare costantemente i processi della Sua organizzazione.

Inizi ora la prova gratuita