Référence API : Processus

Endpoints de Processus

Lister les Processus

Récupérez tous les process d’un tenant.

Endpoint : GET /tenant/{tenantId}/processes

Paramètres :

Réponse :

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

Créer un Processus

Créez un nouveau process dans un tenant.

Endpoint : POST /tenant/{tenantId}/processes

Paramètres :

Request Body :

{
	"displayName": "Mon Nouveau Processus",
	"treeNodeType": "Process",
	"treeParentId": null
}

Réponse : Retourne l’objet du process créé.

Obtenir un Processus

Récupérez les détails d’un process spécifique.

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

Paramètres :

Réponse :

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

Mettre à jour un Processus

Mettez à jour un process (renommer ou déplacer dans un autre dossier).

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

Paramètres :

Request Body :

{
	"displayName": "Nouveau nom de Processus",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Réponse : Retourne l’objet du process mis à jour.

Supprimer un Processus

Supprimez un process et ses données associées.

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

Paramètres :

Réponse :

{
	"success": true
}

Télécharger un BPMN

Importez un fichier BPMN XML pour définir ou mettre à jour un modèle de process.

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

Paramètres :

Request Body :

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

Réponse : Retourne l’objet du process avec le nouveau modèle.

Endpoints de Mapping des Données de Processus

Les data mappings relient les datatables aux process pour visualiser et analyser vos données d’event log sur un modèle de process.

Lister les Mappings de Processus

Récupérez tous les data mappings pour un process.

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

Paramètres :

Réponse :

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

Créer un Mapping de Processus

Ajoutez un mapping de datatable à un process.

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

Paramètres :

Request Body :

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Données de Ventes 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

Réponse : Retourne l’objet mapping créé.

Mettre à jour un Mapping de Processus

Modifiez les paramètres d’affichage d’un data mapping existant.

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

Paramètres :

Request Body :

{
	"displayName": "Nom mis à jour",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Réponse : Retourne l’objet mapping mis à jour.

Supprimer un Mapping de Processus

Retirez un data mapping d’un process.

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

Paramètres :

Réponse :

{
	"success": true
}