Sur cette page
> ressources > documentation > api > Référence de l’API : processus

Référence de l’API : processus

Ces points de terminaison fonctionnent dans votre propre espace de travail. Démarrez l’essai gratuit pour en créer un et effectuer votre premier appel API.

Afficher la liste des processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
limit entier requête Non Nombre maximal d’éléments à renvoyer
offset entier requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des processus

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

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée

Créer un processus (avec un modèle vide)

Point de terminaison : POST /v1/tenant/{tenantId}/processes

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
Champ Type Obligatoire Description
displayName chaîne Oui Nom du processus affiché dans l’arborescence des processus
Longueur maximale : 128
treeParentId chaîne Non Identifiant du dossier parent (null = niveau supérieur)
Format : uuid
treeNodeType Process | TreeGroup Non Processus ou TreeGroup (dossier)
Valeurs autorisées : Process, TreeGroup
Valeur par défaut : Process

Réponse (201) :

Processus créé

{
	"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"
}
Champ Type Obligatoire Description
id chaîne Oui Format : uuid
treeParentId chaîne Oui Format : uuid
treeNodeType Process | TreeGroup Oui Valeurs autorisées : Process, TreeGroup
Valeur par défaut : Process
displayName chaîne Oui Valeur par défaut : New Process
Longueur maximale : 128
createdAt chaîne Oui Format : date-time
updatedAt chaîne Oui Format : date-time
designerModelId chaîne Oui Format : uuid

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 500 Erreur serveur inattendue : vous pouvez relancer la requête sans risque

Récupérer un processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Réponse (200) :

Processus

{
	"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"
}
Champ Type Obligatoire Description
id chaîne Oui Format : uuid
treeParentId chaîne Oui Format : uuid
treeNodeType Process | TreeGroup Oui Valeurs autorisées : Process, TreeGroup
Valeur par défaut : Process
displayName chaîne Oui Valeur par défaut : New Process
Longueur maximale : 128
createdAt chaîne Oui Format : date-time
updatedAt chaîne Oui Format : date-time
designerModelId chaîne Oui Format : uuid

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Modifier un processus

Point de terminaison : PUT /v1/tenant/{tenantId}/processes/{processId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
Champ Type Obligatoire Description
displayName chaîne Non Nom du processus affiché dans l’arborescence des processus
Longueur maximale : 128
treeParentId chaîne Non Identifiant du dossier parent (null = niveau supérieur)
Format : uuid

Réponse (200) :

Processus modifié

{
	"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"
}
Champ Type Obligatoire Description
id chaîne Oui Format : uuid
treeParentId chaîne Oui Format : uuid
treeNodeType Process | TreeGroup Oui Valeurs autorisées : Process, TreeGroup
Valeur par défaut : Process
displayName chaîne Oui Valeur par défaut : New Process
Longueur maximale : 128
createdAt chaîne Oui Format : date-time
updatedAt chaîne Oui Format : date-time
designerModelId chaîne Oui Format : uuid

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable
  • 500 Erreur serveur inattendue : vous pouvez relancer la requête sans risque

Désactiver un processus (suppression réversible)

Point de terminaison : DELETE /v1/tenant/{tenantId}/processes/{processId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Réponse (200) :

Processus supprimé

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success booléen Oui
message chaîne Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Exporter le modèle de processus au format BPMN 2.0 XML

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Réponse (200) :

XML BPMN

{
	"bpmnXml": "string"
}
Champ Type Obligatoire Description
bpmnXml chaîne Oui BPMN 2.0 XML

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée requise ou de l’accès à l’organisation, l’environnement est inactif ou le forfait n’autorise pas ce type de fichier
  • 404 Ressource introuvable
  • 500 Erreur serveur inattendue : la requête peut être relancée sans risque

Importer un modèle BPMN 2.0 pour le processus (remplace le modèle actuel)

Point de terminaison : PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"bpmnXml": "string"
}
Champ Type Obligatoire Description
bpmnXml chaîne Oui BPMN 2.0 XML

Réponse (200) :

BPMN importé

{
	"message": "string"
}
Champ Type Obligatoire Description
message chaîne Oui

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Les associations de données relient les tables de données aux processus. Elles vous permettent de visualiser et d’analyser les données du journal d’événements sur un modèle de processus.

Afficher les associations de données d’un processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid
limit entier requête Non Nombre maximal d’éléments à renvoyer
offset entier requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des associations

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

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Associer une table de données au processus (lance le traitement du journal d’événements)

Point de terminaison : POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
Champ Type Obligatoire Description
dataTableId chaîne Oui Table de données à associer au processus
Format : uuid
displayName chaîne Non Nom d’affichage de l’association
Longueur maximale : 128
color objet Non Couleur d’accentuation
showByDefault booléen Non Afficher cette association par défaut dans la vue du processus
Valeur par défaut : true
mappingRole primary | comparison Non Rôle des données associées dans le modèle
Valeurs autorisées : primary, comparison

Réponse (201) :

Association créée

{
	"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
}
Champ Type Obligatoire Description
id chaîne Oui Format : uuid
modelId chaîne Oui Format : uuid
dataTableId chaîne Oui Format : uuid
displayName chaîne Oui Longueur maximale : 128
color objet Oui
showByDefault booléen Oui Valeur par défaut : true
mappingRole primary | comparison Oui Valeurs autorisées : primary, comparison
Valeur par défaut : comparison
sortOrder entier Oui Valeur par défaut : 0
Minimum : -9007199254740991
Maximum : 9007199254740991

Erreurs :

  • 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant, par exemple
  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée requise ou de l’accès à l’organisation, l’environnement est inactif ou le forfait n’autorise pas ce type de fichier
  • 404 Ressource introuvable

Modifier une association

Point de terminaison : PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid
mappingId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Champ Type Obligatoire Description
displayName chaîne Non Longueur maximale : 128
color objet Non
showByDefault booléen Non
mappingRole primary | comparison Non Valeurs autorisées : primary, comparison
sortOrder entier Non Minimum : -9007199254740991
Maximum : 9007199254740991

Réponse (200) :

Association modifiée

{
	"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
}
Champ Type Obligatoire Description
id chaîne Oui Format : uuid
modelId chaîne Oui Format : uuid
dataTableId chaîne Oui Format : uuid
displayName chaîne Oui Longueur maximale : 128
color objet Oui
showByDefault booléen Oui Valeur par défaut : true
mappingRole primary | comparison Oui Valeurs autorisées : primary, comparison
Valeur par défaut : comparison
sortOrder entier Oui Valeur par défaut : 0
Minimum : -9007199254740991
Maximum : 9007199254740991

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Supprimer une association

Point de terminaison : DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid
mappingId chaîne chemin Oui Format : uuid

Réponse (200) :

Association supprimée

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success booléen Oui
message chaîne Oui

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Ces points de terminaison utilisent l’IA pour générer automatiquement des modèles de processus BPMN à partir de descriptions en langage naturel.

Générer un modèle de processus à partir d’une instruction en langage naturel (asynchrone ; interroger le point de terminaison de statut)

Point de terminaison : POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Authentification : Clé API limitée à l’environnement · portée write · limite de débit : 2 requêtes/s (rafale de 4)

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"prompt": "string"
}
Champ Type Obligatoire Description
prompt chaîne Oui

Réponse (200) :

Génération lancée / résultat

{
	"message": "string"
}
Champ Type Obligatoire Description
message chaîne Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Consulter le statut de génération du modèle

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Réponse (200) :

Statut de génération

{
	"message": "string"
}
Champ Type Obligatoire Description
message chaîne Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Les métriques par dossier de la dernière version du modèle de processus : une ligne par dossier, avec la séquence calculée et les métriques de santé.

Récupérer les métriques par dossier d’un processus (dernière version du modèle, résultats paginés)

Renvoie une ligne par dossier avec les métriques calculées du processus (durée, longueur, conformité, reprises, score de santé, variante, etc.) pour la dernière version de son modèle. Aucun filtrage des lignes n’est appliqué. Les résultats sont paginés : utilisez limit (valeur par défaut : 1 000, maximum : 10 000) et offset, puis poursuivez la pagination tant que hasMore est vrai. Tant que le calcul des métriques n’est pas terminé, la réponse indique l’état preprocessing.

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid
limit entier requête Non Nombre maximal de lignes de dossiers à renvoyer (valeur par défaut : 1 000, maximum : 10 000)
offset entier requête Non Nombre de lignes de dossiers à ignorer (valeur par défaut : 0)

Réponse (200) :

Métriques des dossiers

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

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable
  • 503 Pipeline de données non prêt ou échec d’une requête en amont

Afficher les versions d’un processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/versions

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid
limit entier requête Non Nombre maximal d’éléments à renvoyer
offset entier requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des versions

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

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Créer un instantané de version du processus

Point de terminaison : POST /v1/tenant/{tenantId}/processes/{processId}/versions

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
processId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
Champ Type Obligatoire Description
displayName chaîne Non Libellé de la version
Valeur par défaut : ""
Longueur maximale : 128
description chaîne Non Description facultative de la version
versionType manual | auto Non manuel = créé par l’utilisateur, auto = créé par le système
Valeurs autorisées : manual, auto
restoreFromVersionId chaîne Non Version à restaurer lors de la création de cet instantané
Format : uuid

Réponse (201) :

Version créée

{
	"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
	}
}
Champ Type Obligatoire Description
version object Oui
restoredFrom object Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Récupérer une version du processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
processId string chemin Oui Format : uuid
versionId string chemin Oui Format : uuid

Réponse (200) :

Version

{
	"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
	}
}
Champ Type Obligatoire Description
version object Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Renommer ou modifier une version du processus

Point de terminaison : PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
processId string chemin Oui Format : uuid
versionId string chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"description": "string"
}
Champ Type Obligatoire Description
displayName string Non Libellé de la version
Longueur maximale : 128
description string Non Description facultative de la version

Réponse (200) :

Version modifiée

{
	"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
	}
}
Champ Type Obligatoire Description
version object Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Supprimer une version du processus

Point de terminaison : DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
processId string chemin Oui Format : uuid
versionId string chemin Oui Format : uuid

Réponse (200) :

Version supprimée

{
	"deleted": true
}
Champ Type Obligatoire Description
deleted boolean Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Récupérer un artefact

Point de terminaison : GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
artifactId string chemin Oui Format : uuid

Réponse (200) :

Artefact

{
	"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"
}
Champ Type Obligatoire Description
id string Oui Format : uuid
displayName string Oui Valeur par défaut : ""
Longueur maximale : 500
description string Oui Longueur maximale : 2000
originalFileName string Oui Valeur par défaut : ""
Longueur maximale : 500
mimeType string Oui Valeur par défaut : ""
Longueur maximale : 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Oui Valeurs autorisées : Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Oui Valeurs autorisées : modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Valeur par défaut : modelIcon
uploadState Uploading | Ready | Failed | Deleted Oui Valeurs autorisées : Uploading, Ready, Failed, Deleted
Valeur par défaut : Uploading
hasThumbnail boolean Oui Valeur par défaut : false
sizeBytes number Oui Valeur par défaut : 0
createdAt string Oui Format : date-time
createdBy string Non Format : uuid

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Modifier le nom d’affichage ou la description d’un artefact

Point de terminaison : PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
artifactId string chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"description": "string"
}
Champ Type Obligatoire Description
displayName string Non Nom de l’artefact
Longueur maximale : 500
description string Non Description facultative de l’artefact
Longueur maximale : 2000

Réponse (200) :

Artefact modifié

{
	"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"
}
Champ Type Obligatoire Description
id string Oui Format : uuid
displayName string Oui Valeur par défaut : ""
Longueur maximale : 500
description string Oui Longueur maximale : 2000
originalFileName string Oui Valeur par défaut : ""
Longueur maximale : 500
mimeType string Oui Valeur par défaut : ""
Longueur maximale : 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Oui Valeurs autorisées : Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Oui Valeurs autorisées : modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Valeur par défaut : modelIcon
uploadState Uploading | Ready | Failed | Deleted Oui Valeurs autorisées : Uploading, Ready, Failed, Deleted
Valeur par défaut : Uploading
hasThumbnail boolean Oui Valeur par défaut : false
sizeBytes number Oui Valeur par défaut : 0
createdAt string Oui Format : date-time
createdBy string Non Format : uuid

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Supprimer un artefact

Point de terminaison : DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
artifactId string chemin Oui Format : uuid

Réponse (200) :

Artefact supprimé

{
	"deleted": true
}
Champ Type Obligatoire Description
deleted boolean Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Rediriger vers une URL pré-signée pour télécharger l’artefact

Point de terminaison : GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
artifactId string chemin Oui Format : uuid

Erreurs :

  • 302 Redirection vers l’URL de téléchargement pré-signée
  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Lister les artefacts associés à un processus

Point de terminaison : GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
processId string chemin Oui Format : uuid
limit integer requête Non Nombre maximal d’éléments à renvoyer
offset integer requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des artefacts du processus

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

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Obtenir une URL S3 pré-signée pour importer un nouvel artefact de processus

Point de terminaison : POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
processId string chemin Oui Format : uuid

Corps de la requête :

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
Champ Type Obligatoire Description
fileName string Oui
mimeType string Oui
sizeBytes number Oui
artifactType modelIcon | processArtifact | doc | levelFrontPageImage Non Valeurs autorisées : modelIcon, processArtifact, doc, levelFrontPageImage
Valeur par défaut : processArtifact

Réponse (200) :

URL d’importation pré-signée

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
Champ Type Obligatoire Description
artifactId string Oui Format : uuid
originalUrl string Oui
thumbnailUrl string Oui

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre invalide, processus sans modèle, type d’importation non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée requise ou de l’accès à l’organisation, l’environnement est inactif ou le forfait n’autorise pas ce type de fichier
  • 404 Ressource introuvable
  • 409 La requête est incompatible avec l’état actuel (par exemple, une restriction liée à une licence utilisateur ou un identifiant déjà utilisé)

Documentation associée

Concevez de meilleurs processus. Bâtissez une architecture cohérente. Gardez la maîtrise.

Accédez immédiatement à la plateforme, sans carte bancaire ni attente. Représentez clairement le fonctionnement de votre organisation dans des modèles de processus reliés entre eux.

Définissez l’architecture des processus, les responsabilités et les contrôles, puis clarifiez les rôles à chaque niveau.

Démarrez votre essai gratuit et posez les bases d’une gouvernance, d’une gestion et d’une amélioration continue de vos processus.

Démarrez votre essai gratuit dès aujourd’hui.