Riferimento API: processi

Elencare i processi

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

Autenticazione: Chiave API con ambito 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 processi

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta

Creare un processo (con un modello vuoto)

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

Autenticazione: Chiave API con ambito 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": "Process"
}

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

Risposta (201):

Processo creato

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
treeParentId	string	Sì	Formato: uuid
treeNodeType	Process | TreeGroup	Sì	Valori consentiti: Process, TreeGroup Predefinito: Process
displayName	string	Sì	Predefinito: New Process Lunghezza massima: 128
createdAt	string	Sì	Formato: date-time
updatedAt	string	Sì	Formato: date-time
designerModelId	string	Sì	Formato: uuid

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 500 Errore imprevisto del server: è possibile ripetere la richiesta senza rischi

Recuperare un processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

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

Risposta (200):

Processo

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
treeParentId	string	Sì	Formato: uuid
treeNodeType	Process | TreeGroup	Sì	Valori consentiti: Process, TreeGroup Predefinito: Process
displayName	string	Sì	Predefinito: New Process Lunghezza massima: 128
createdAt	string	Sì	Formato: date-time
updatedAt	string	Sì	Formato: date-time
designerModelId	string	Sì	Formato: uuid

Errori:

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

Aggiornare un processo

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Nome del processo visualizzato nell’albero dei processi Lunghezza massima: 128
treeParentId	string	No	ID della cartella principale (null = livello superiore) Formato: uuid

Risposta (200):

Processo aggiornato

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
treeParentId	string	Sì	Formato: uuid
treeNodeType	Process | TreeGroup	Sì	Valori consentiti: Process, TreeGroup Predefinito: Process
displayName	string	Sì	Predefinito: New Process Lunghezza massima: 128
createdAt	string	Sì	Formato: date-time
updatedAt	string	Sì	Formato: date-time
designerModelId	string	Sì	Formato: uuid

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata
• 500 Errore imprevisto del server: è possibile ripetere la richiesta senza rischi

Eliminare logicamente un processo

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Risposta (200):

Processo 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

Esportare il modello di processo come XML BPMN 2.0

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

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

Risposta (200):

XML BPMN

{
	"bpmnXml": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
bpmnXml	string	Sì	XML BPMN 2.0

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata
• 500 Errore imprevisto del server: è possibile ripetere la richiesta senza rischi

Importare un modello BPMN 2.0 per il processo (sostituisce il modello attuale)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"bpmnXml": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
bpmnXml	string	Sì	XML BPMN 2.0

Risposta (200):

BPMN caricato

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

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

Le mappature dei dati collegano le tabelle di dati ai processi, consentendo di visualizzare e analizzare i dati dell’Event Log su un modello di processo.

Elencare le mappature dei dati di un processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
processId	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 mappature

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Errori:

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

Associare una tabella di dati al processo (avvia l’elaborazione dell’Event Log)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Campo	Tipo	Obbligatorio	Descrizione
dataTableId	string	Sì	Tabella di dati da associare al processo Formato: uuid
displayName	string	No	Nome visualizzato della mappatura Lunghezza massima: 128
color	object	No	Colore di accento
showByDefault	boolean	No	Mostra questa mappatura per impostazione predefinita nella vista del processo Predefinito: true
mappingRole	primary | comparison	No	Ruolo dei dati associati nel modello Valori consentiti: primary, comparison

Risposta (201):

Mappatura creata

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
modelId	string	Sì	Formato: uuid
dataTableId	string	Sì	Formato: uuid
displayName	string	Sì	Lunghezza massima: 128
color	object	Sì
showByDefault	boolean	Sì	Predefinito: true
mappingRole	primary | comparison	Sì	Valori consentiti: primary, comparison Predefinito: comparison
sortOrder	integer	Sì	Predefinito: 0 Minimo: -9007199254740991 Massimo: 9007199254740991

Errori:

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

Aggiornare una mappatura

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Lunghezza massima: 128
color	object	No
showByDefault	boolean	No
mappingRole	primary | comparison	No	Valori consentiti: primary, comparison
sortOrder	integer	No	Minimo: -9007199254740991 Massimo: 9007199254740991

Risposta (200):

Mappatura aggiornata

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
modelId	string	Sì	Formato: uuid
dataTableId	string	Sì	Formato: uuid
displayName	string	Sì	Lunghezza massima: 128
color	object	Sì
showByDefault	boolean	Sì	Predefinito: true
mappingRole	primary | comparison	Sì	Valori consentiti: primary, comparison Predefinito: comparison
sortOrder	integer	Sì	Predefinito: 0 Minimo: -9007199254740991 Massimo: 9007199254740991

Errori:

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

Eliminare una mappatura

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Risposta (200):

Mappatura eliminata

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

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

Errori:

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

Questi endpoint utilizzano l’AI per generare automaticamente modelli di processo BPMN a partire da descrizioni in linguaggio naturale.

Generare un modello di processo da un prompt in linguaggio naturale (asincrono; verificare lo stato tramite l’endpoint dedicato)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Autenticazione: Chiave API con ambito Tenant · ambito write · limite di frequenza: 2 richieste/s (picco 4)

Parametri:

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

Corpo della richiesta:

{
	"prompt": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
prompt	string	Sì

Risposta (200):

Generazione avviata / risultato

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

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

Verificare lo stato della generazione del modello

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Risposta (200):

Stato della generazione

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

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

Le metriche per singolo caso dell’ultimo modello del processo: una riga per ogni caso con la sequenza calcolata e le metriche di salute.

Recuperare le metriche per singolo caso di un processo (ultimo modello, risultati paginati)

Restituisce una riga per ogni caso con le metriche di processo calcolate (durata del caso, lunghezza, conformità, rilavorazioni, punteggio di salute, variante e altro) relative all’ultimo modello del processo. Non viene applicato alcun filtro alle righe. I risultati sono paginati: utilizzare limit (valore predefinito 1000, massimo 10000) e offset, continuando a richiedere le pagine finché hasMore è true. Se il calcolo delle metriche è ancora in corso, la risposta riporta lo stato preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
processId	string	path	Sì	Formato: uuid
limit	integer	query	No	Numero massimo di righe di casi da restituire (valore predefinito 1000, massimo 10000)
offset	integer	query	No	Numero di righe di casi da ignorare (valore predefinito 0)

Risposta (200):

Metriche dei casi

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Errori:

• 400 Richiesta non valida: ad esempio, espressione di filtro non valida, processo senza modello, tipo di file non supportato o campo obbligatorio mancante
• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata
• 503 Pipeline dei dati non pronta o errore nella query a monte

Elencare le versioni del processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
processId	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 versioni

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Errori:

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

Creare un’istantanea della versione del processo

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Etichetta della versione Predefinito: "" Lunghezza massima: 128
description	string	No	Descrizione facoltativa della versione
versionType	manual | auto	No	manuale = creata dall’utente, auto = creata dal sistema Valori consentiti: manual, auto
restoreFromVersionId	string	No	Versione da cui ripristinare il processo durante la creazione di questa istantanea Formato: uuid

Risposta (201):

Versione creata

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obbligatorio	Descrizione
version	object	Sì
restoredFrom	object	Sì

Errori:

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

Recuperare una versione del processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

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

Risposta (200):

Versione

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obbligatorio	Descrizione
version	object	Sì

Errori:

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

Rinominare o aggiornare una versione del processo

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"displayName": "string",
	"description": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Etichetta della versione Lunghezza massima: 128
description	string	No	Descrizione facoltativa della versione

Risposta (200):

Versione aggiornata

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obbligatorio	Descrizione
version	object	Sì

Errori:

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

Eliminare una versione del processo

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Risposta (200):

Versione eliminata

{
	"deleted": true
}

Campo	Tipo	Obbligatorio	Descrizione
deleted	boolean	Sì

Errori:

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

Recuperare un artefatto

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

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

Risposta (200):

Artefatto

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
displayName	string	Sì	Predefinito: "" Lunghezza massima: 500
description	string	Sì	Lunghezza massima: 2000
originalFileName	string	Sì	Predefinito: "" Lunghezza massima: 500
mimeType	string	Sì	Predefinito: "" Lunghezza massima: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Sì	Valori consentiti: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Sì	Valori consentiti: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Predefinito: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Sì	Valori consentiti: Uploading, Ready, Failed, Deleted Predefinito: Uploading
hasThumbnail	boolean	Sì	Predefinito: false
sizeBytes	number	Sì	Predefinito: 0
createdAt	string	Sì	Formato: date-time
createdBy	string	No	Formato: uuid

Errori:

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

Modificare il nome visualizzato o la descrizione di un artefatto

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"displayName": "string",
	"description": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Nome dell’artefatto Lunghezza massima: 500
description	string	No	Descrizione facoltativa dell’artefatto Lunghezza massima: 2000

Risposta (200):

Artefatto aggiornato

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
displayName	string	Sì	Predefinito: "" Lunghezza massima: 500
description	string	Sì	Lunghezza massima: 2000
originalFileName	string	Sì	Predefinito: "" Lunghezza massima: 500
mimeType	string	Sì	Predefinito: "" Lunghezza massima: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Sì	Valori consentiti: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Sì	Valori consentiti: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Predefinito: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Sì	Valori consentiti: Uploading, Ready, Failed, Deleted Predefinito: Uploading
hasThumbnail	boolean	Sì	Predefinito: false
sizeBytes	number	Sì	Predefinito: 0
createdAt	string	Sì	Formato: date-time
createdBy	string	No	Formato: uuid

Errori:

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

Eliminare un artefatto

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Risposta (200):

Artefatto eliminato

{
	"deleted": true
}

Campo	Tipo	Obbligatorio	Descrizione
deleted	boolean	Sì

Errori:

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

Reindirizzare a un URL firmato per scaricare l’artefatto

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

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

Errori:

• 302 Reindirizzamento all’URL firmato per il download
• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata

Elencare gli artefatti associati a un processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
processId	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 degli artefatti del processo

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Errori:

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

Ottenere un URL di caricamento S3 firmato per un nuovo artefatto del processo

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Corpo della richiesta:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Campo	Tipo	Obbligatorio	Descrizione
fileName	string	Sì
mimeType	string	Sì
sizeBytes	number	Sì
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	No	Valori consentiti: modelIcon, processArtifact, doc, levelFrontPageImage Predefinito: processArtifact

Risposta (200):

URL di caricamento firmato

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
artifactId	string	Sì	Formato: uuid
originalUrl	string	Sì
thumbnailUrl	string	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
• 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
• 409 La richiesta è in conflitto con lo stato attuale (ad esempio, per un limite di postazioni o un ID già utilizzato)