API Reference: Processi

Endpoint Processi

Elenco Processes

Recupera tutti i processi in un tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parametri:

Risposta:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

Crea Process

Crea un nuovo process in un tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parametri:

Request Body:

{
	"displayName": "My New Process",
	"treeNodeType": "Process",
	"treeParentId": null
}

Risposta: Restituisce l’oggetto process creato.

Get Process

Recupera i dettagli di uno specifico process.

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

Parametri:

Risposta:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

Aggiorna Process

Aggiorna un process (rinomina o sposta in un’altra cartella).

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

Parametri:

Request Body:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Risposta: Restituisce l’oggetto process aggiornato.

Elimina Process

Elimina un process e i dati associati.

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

Parametri:

Risposta:

{
	"success": true
}

Upload BPMN

Carica un file XML BPMN per definire o aggiornare un modello di process.

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

Parametri:

Request Body:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Risposta: Restituisce l’oggetto process aggiornato con il nuovo modello.

Endpoint Process Data Mapping

I data mapping collegano le datatable ai processi e consentono di visualizzare e analizzare i dati degli event log su un modello di process.

Elenco Process Mapping

Recupera tutti i data mapping di un process.

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

Parametri:

Risposta:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

Crea Process Mapping

Aggiungi un mapping di data table a un process.

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

Parametri:

Request Body:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

Risposta: Restituisce l’oggetto mapping creato.

Aggiorna Process Mapping

Aggiorna le impostazioni di visualizzazione di un data mapping esistente.

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

Parametri:

Request Body:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Risposta: Restituisce l’oggetto mapping aggiornato.

Elimina Process Mapping

Rimuovi un data mapping da un process.

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

Parametri:

Risposta:

{
	"success": true
}