Référence API : Processus

Endpoints de Processus

Lister les Processus

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

Endpoint : GET /tenant/{tenantId}/processes

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant

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 processus dans un tenant.

Endpoint : POST /tenant/{tenantId}/processes

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant

Corps de la requête :

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

Champ	Type	Requis	Descriptionn
displayName	string	Oui	Nom du processus
treeNodeType	string	Non	Doit être Process (défaut) ou TreeGroup
treeParentId	string	Non	ID du dossier parent pour organiser les processus

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

---

Obtenir un Processus

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

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

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 processus (renommer ou déplacer dans un autre dossier).

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

Corps de la requête :

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

Champ	Type	Requis	Descriptionn
displayName	string	Non	Nouveau nom pour le processus
treeParentId	string	Non	Nouvel ID du dossier parent

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

---

Supprimer un Processus

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

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

Réponse :

{
	"success": true
}

---

Importer un BPMN

Téléversez un fichier XML BPMN pour définir ou mettre à jour un modèle de processus.

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

Corps de la requête :

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

Champ	Type	Obligatoire	Descriptionn
bpmnXml	string	Oui	Contenu XML BPMN 2.0 sous forme de chaîne de caractères

Réponse : Renvoie le processus mis à jour avec le nouveau modèle.

---

Endpoints de Mapping des Données de Processus

Les data mappings relient les donnéestables aux process pour visualiser et analyser vos journaux d’événements sur un modèle de processus.

Lister les Mappings de Processus

Récupérez tous les données mappings pour un processus.

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

Réponse :

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

---

Créer un Mapping de Processus

Ajoutez un cartographie des donnéestable à un process.

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process

Corps de la requête :

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

Champ	Type	Requis	Descriptionn
dataTableId	string	Oui	ID de la table de données à mapper
displayName	string	Non	Nom affiché pour le mapping
color	object	Non	Objet couleur avec champ id (data-1 à data-11)
showByDefault	boolean	Non	Affichée par défaut (défaut : 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 :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process
mappingId	string	path	Oui	Identifiant unique du mapping

Corps de la requête :

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

Champ	Type	Requis	Descriptionn
displayName	string	Non	Nouveau nom affiché
color	object	Non	Objet couleur avec champ id (data-1 à data-11)
showByDefault	boolean	Non	Nouvelle visibilité par défaut

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

---

Supprimer un Mapping de Processus

Retirez un mapping de données d’un processus.

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

Paramètres :

Nom	Type	Emplacement	Requis	Descriptionn
tenantId	string	path	Oui	Identifiant unique du tenant
processId	string	path	Oui	Identifiant unique du process
mappingId	string	path	Oui	Identifiant unique du mapping

Réponse :

{
	"success": true
}