Celonis (préversion)
API De la plateforme Celonis pour travailler avec des éléments knowledge Model, tels que des enregistrements, des indicateurs de performance clés, des filtres, des déclencheurs et leurs données associées.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge de Celonis |
| URL | https://developer.celonis.com/ |
| Messagerie électronique | intelligence-api-feedback-sc@celonis.de |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Celonis |
| Site internet | https://www.celonis.com |
| Politique de confidentialité | https://www.celonis.com/privacy-policy/ |
| Catégories | IA; Gestion de l’entreprise |
Titre
L’API Celonis Intelligence permet aux clients Celonis d’incorporer l’intelligence des processus actionnables dans des plateformes tierces où les utilisateurs finaux peuvent tirer parti des insights de processus Celonis. De cette façon, elle permettrait à Celonis d’obtenir des informations telles que des indicateurs de performance clés de processus ou des inefficacités de processus plus proches des utilisateurs finaux et de bénéficier aux utilisateurs opérationnels sans accès actuel à Celonis en fournissant des insights précieux pour une meilleure prise de décision tout en exécutant leurs activités quotidiennes. Outre la fonctionnalité de requête de données, l’API Intelligence prend également en charge l’envoi de données vers des plateformes tierces en leur permettant de s’abonner aux déclencheurs métier.
Éditeur : Nom du serveur de publication
Prerequisites
- Une équipe de Celonis Platform.
- Modèle de connaissances disponible dans l’équipe d’un client.
- Abonnement Celonis basé sur le processus (contactez l’équipe de votre compte pour vérifier).
Opérations prises en charge
Les méthodes d’API actuelles permettent aux consommateurs d’interagir avec les modèles de connaissances définis dans la plateforme Celonis en fournissant les fonctionnalités suivantes :
Méthodes de découverte de modèle de connaissances
Obtenir la liste des modèles de connaissances (KM)
Obtenir la liste des enregistrements KM
Obtenir les détails d’un schéma d’enregistrement KM
Obtenir la liste des filtres KM
Méthodes de récupération des données du modèle de connaissances
Obtenir la liste des données d’enregistrement KM
Méthodes de gestion du cycle de vie des abonnements
Obtenir la liste des abonnements
Obtenir la liste des déclencheurs KM
Créer un abonnement à un déclencheur KM
Mettre à jour un abonnement
Suspendre un abonnement
Reprendre un abonnement
Terminer un abonnement
Obtention des informations d’identification
Authentication
Chaque requête adressée à l’API doit être authentifiée avec une clé API Celonis. Il existe deux façons de procéder :
Utilisation d’une clé API utilisateur
Vous pouvez découvrir comment créer une clé API utilisateur en suivant notre guide des clés API utilisateur . L’API Celonis utilise l’authentification par jeton du porteur pour vérifier l’accès du consommateur. Les informations d’identification doivent être envoyées dans un en-tête d’autorisation dans la requête HTTP. Les informations d’identification envoyées dans l’URL ou le corps de la demande sont ignorées. Pour vous authentifier à l’aide de l’authentification par jeton du porteur :
- Créez le jeton dans Celonis :
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Incluez la chaîne dans l’en-tête d’autorisation HTTP mis en forme comme suit :
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Utilisation d’une clé API d’application
Vous pouvez découvrir comment créer une clé AppKey en suivant notre guide des clés API d’application . Pour vous authentifier à l’aide de l’authentification AppKey :
- Créez l’AppKey dans Celonis :
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Incluez la chaîne dans l’en-tête d’autorisation HTTP mis en forme comme suit :
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Vous devez définir les autorisations appropriées et vous assurer que la clé API utilisateur ou la clé API d’application exploitée à des fins d’autorisation a accès au package Celonis Studio contenant les modèles de connaissances que vous souhaitez accéder via des API Intelligence. Vous pouvez accorder des autorisations d’accès en procédant comme suit :
- Accédez au package Studio.
- Cliquez sur les trois points et sélectionnez-le
Permissionsdans le menu contextuel. - Recherchez l’utilisateur (au cas où vous utilisez un jeton porteur ) ou AppKey (au cas où vous utilisez une clé AppKey ) et accordez au moins
USE PACKAGEdes droits.
Getting Started
L’URL de base de l’API Celonis consiste https://<team>.<cluster>.celonis.cloud/intelligence/api à rechercher l’équipe et le cluster, vérifiez l’URL que vous utilisez pour accéder à la plateforme Celonis et récupérer l’équipe et le cluster à partir de celui-ci.
L’API Celonis Intelligence est une API JSON et ses points de terminaison retournent toujours une réponse JSON, quelle que soit la réussite de la requête.
Les méthodes d’API actuelles permettent aux consommateurs d’interagir avec les modèles de connaissances définis dans la plateforme Celonis en fournissant les fonctionnalités suivantes :
- Liste des modèles de connaissances disponibles et leurs détails
- Liste des enregistrements et de leurs détails
- Liste des filtres
- Données d’un enregistrement spécifique. Détails sur les fonctionnalités de l’API Celonis Intelligence sur le portail des développeurs Celonis.
Problèmes connus et limitations
Limitation du débit
L’API Intelligence n’a pas été créée pour exporter en bloc des données BRUTEs, mais pour rendre les résultats calculés et les insights de l’exploration de données de processus disponibles pour les plateformes et applications tierces. C’est pourquoi l’API Celonis applique la limitation du débit. Cela signifie que seul un certain nombre de demandes sont autorisées par jour et qu’un certain nombre d’enregistrements peuvent être récupérés dans chaque appel. Celonis se réserve le droit d’ajuster les limites de tarifs à tout moment pour garantir un service de haute qualité pour tous les clients.
Si un client dépasse à plusieurs reprises les limites de débit ou s’engage dans un comportement considéré comme suspect, Celonis se réserve le droit de limiter ou de suspendre temporairement ou définitivement l’accès à l’API pour ce client.
Lorsqu’un client dépasse le nombre de requêtes par jour, l’API Celonis retourne une réponse de 429 (trop de requêtes), y compris un en-tête HTTP () qui indique le temps (x-ratelimit-reseten secondes) nécessaire au traitement d’une nouvelle requête.
Les en-têtes HTTP suivants sont également retournés dans le cadre de chaque appel :
-
x-ratelimit-limit: représente le nombre maximal de requêtes que le client peut effectuer dans la fenêtre de temps actuelle. -
x-ratelimit-remaining: nombre de requêtes restantes dans la fenêtre de temps actuelle. Actuellement, l’API a les limites par défaut suivantes :
Tableau 1. Limites de taux de requêtes par défaut
|
Limite | Valeurs par défaut | |--|--| | Nombre maximal de requêtes/jour | 6000 demandes/jour | | Nombre maximal de requêtes/seconde | 20 requêtes/seconde | | Nombre maximal de champs autorisés par requête dans le modèle de connaissances | 200 fields/request | | Nombre maximal d’enregistrements par requête retourné lors de l’appel du /data point de terminaison | 50 enregistrements/requête | | | Nombre maximal total d’enregistrements pouvant être récupérés via le /data point de terminaison | Premiers 5.000 enregistrements par table filtrée/triée | L’abonnement au déclencheur applique également la limitation du débit. Cela signifie que pour une équipe, seul un certain nombre d’abonnements peut être créé. En outre, quel que soit le nombre d’abonnements créés, il existe un nombre maximal d’événements qui peuvent être émis de l’API aux consommateurs tiers.
Si un client atteint le nombre maximal d’abonnements, il doit supprimer un abonnement existant pour en créer un.
Si un client atteint le nombre maximal d’événements émis à partir de l’API, le reste des données produites par La plateforme Celonis est ignorée.
Si le client approche de son quota quotidien, il sera informé par e-mail de votre compte d’administrateur. Le premier e-mail sera envoyé lorsque 80% du quota est dépassé, ce qui permet à votre compte d’administrateur de savoir que vous dépassez ce pourcentage. Le deuxième e-mail sera envoyé dès que vous dépassez 100% du quota.
Actuellement, l’API a les limites par défaut suivantes :
Tableau 2. Limites du taux d’événements par défaut
|
Limite | Valeurs par défaut | |--|--| | Nombre maximal d’abonnements/d’équipe | 10 | | Nombre maximal d’événements/jour | 100,000 | Consultez votre équipe de compte pour vérifier les limites de votre équipe.
Questions fréquentes
Reportez-vous à la section Forum aux questions dans le portail des développeurs Celonis.
Instructions de déploiement
Obligatoire. Ajoutez des instructions sur le déploiement de ce connecteur en tant que connecteur personnalisé.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Équipe | ficelle | Spécifiez l’équipe Celonis. | Vrai |
| Cluster | ficelle | Spécifiez le cluster Celonis. | Vrai |
| Authorization | securestring | Autorisation pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Crée un abonnement pour le déclencheur |
Crée un abonnement pour le déclencheur |
| Interrompt l’abonnement pour arrêter la réception d’événements |
Interrompt l’abonnement pour arrêter la réception d’événements |
| Met à jour un abonnement |
Met à jour un abonnement |
| Obtenir la liste des abonnements |
Liste de tous les abonnements créés |
| Obtenir la liste des données d’enregistrement KM |
Données d’un enregistrement dans le modèle de connaissances |
| Obtenir la liste des déclencheurs KM |
Liste des déclencheurs pour le modèle de connaissances |
| Obtenir la liste des filtres KM |
Liste des filtres pour le modèle de connaissances |
| Obtenir la liste des machines virtuelles |
Liste des modèles de connaissances définis dans une équipe EMS |
| Obtenir la liste du schéma d’enregistrements KM |
Liste des schémas d’enregistrements |
| Obtenir les détails du km de niveau supérieur |
Modèle de connaissances défini dans une équipe EMS |
| Obtenir les détails du schéma d’enregistrement KM de niveau supérieur |
Détails du schéma d’enregistrement de niveau supérieur |
| Reprend l’abonnement pour commencer à recevoir de nouveaux événements, ignorer les événements d’historique |
Reprend l’abonnement suspendu pour commencer à recevoir de nouveaux événements, en ignorant les événements d’historique |
| Reprend l’abonnement suspendu pour commencer à recevoir à nouveau des événements |
Reprend l’abonnement suspendu pour commencer à recevoir à nouveau des événements |
| Récupère la page suivante des événements qui n’ont pas été transférés en raison d’un abonnement ayant échoué |
Récupère la page suivante des événements s’ils n’ont pas été transférés en raison d’un abonnement ayant échoué |
| Se désabonner d’un déclencheur supprimant toutes les données de l’abonnement |
Se désabonner d’un déclencheur supprimant toutes les données de l’abonnement |
Crée un abonnement pour le déclencheur
Crée un abonnement pour le déclencheur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
ID du modèle de connaissances |
|
ID de déclencheur
|
trigger_id | True | string |
ID de déclencheur |
|
headers
|
headers | object |
Les en-têtes de rappel peuvent contenir un jeton d’authentification, un type de contenu, etc. |
|
|
protocol
|
protocol | True | string |
Seule la valeur possible est HTTPS, ce qui signifie que l’URI de rappel doit être un https valide |
|
URI
|
uri | True | string |
Uri pour effectuer le rappel à partir de l’API Intelligence une fois le déclencheur déclenché |
|
configurations
|
configurations | array of string |
Configuration de l’abonnement |
|
|
nom
|
name | True | string |
Nom de l’abonnement |
Retours
- response
- string
Interrompt l’abonnement pour arrêter la réception d’événements
Interrompt l’abonnement pour arrêter la réception d’événements
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
L’ID d’abonnement sera suspendu |
Met à jour un abonnement
Met à jour un abonnement
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
ID d’abonnement qui sera entièrement mis à jour |
|
headers
|
headers | object |
Les en-têtes de rappel peuvent contenir un jeton d’authentification, un type de contenu, etc. |
|
|
protocol
|
protocol | True | string |
Seule la valeur possible est HTTPS, ce qui signifie que l’URI de rappel doit être un https valide |
|
URI
|
uri | True | string |
Uri pour effectuer le rappel à partir de l’API Intelligence une fois le déclencheur déclenché |
|
configurations
|
configurations | array of string |
Configuration de l’abonnement |
|
|
nom
|
name | True | string |
Nom de l’abonnement |
Obtenir la liste des abonnements
Liste de tous les abonnements créés
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Trier
|
sort | string |
Définit la stratégie à suivre pour le tri non respect de la casse. Il doit s’agir d’un seul champ, et il doit commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Un préfixe non trie asC. Le champ non existant dans l’en-tête génère une erreur |
Retours
- Page de résultats du schéma d’abonnement
- subscriptionResultPage
Obtenir la liste des données d’enregistrement KM
Données d’un enregistrement dans le modèle de connaissances
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du modèle de connaissances
|
km_id | True | string |
ID du modèle de connaissances |
|
ID enregistrement
|
record_id | True | string |
ID enregistrement |
|
Filtres
|
filters | array |
ID de filtre prédéfini |
|
|
ID de champ
|
fields | True | array |
ID de filtre prédéfini |
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Tri
|
sort | array |
Définit la stratégie à suivre pour le tri. Il doit s’agir d’une liste de champs séparés par des virgules, et ils doivent commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Les champs sans préfixe seront triés comme ASC. Les champs non existants dans l’en-tête lèvent une erreur |
|
|
Expression de filtre
|
filterExpr | array |
Expressions de filtre dynamique |
Retours
- Page de résultats de l’enregistrement des données
- recordResultPageDTO
Obtenir la liste des déclencheurs KM
Liste des déclencheurs pour le modèle de connaissances
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Trier
|
sort | string |
Définit la stratégie à suivre pour le tri non respect de la casse. Il doit s’agir d’un seul champ, et il doit commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Un préfixe non trie asC. Le champ non existant dans l’en-tête génère une erreur |
|
|
Km Id
|
km_id | True | string |
ID du modèle de connaissances |
Retours
- Page de résultats du schéma de déclencheur
- triggerResultPage
Obtenir la liste des filtres KM
Liste des filtres pour le modèle de connaissances
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Tri
|
sort | string |
Définit la stratégie à suivre pour le tri non respect de la casse. Il doit s’agir d’un seul champ, et il doit commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Un préfixe non trie asC. Le champ non existant dans l’en-tête génère une erreur |
|
|
ID du modèle de connaissances
|
km_id | True | string |
ID du modèle de connaissances |
Retours
- Page de résultats du schéma de filtre
- filterResultPage
Obtenir la liste des machines virtuelles
Liste des modèles de connaissances définis dans une équipe EMS
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Tri
|
sort | string |
Définit la stratégie à suivre pour le tri non respect de la casse. Il doit s’agir d’un seul champ, et il doit commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Un préfixe non trie asC. Le champ non existant dans l’en-tête génère une erreur |
Retours
- Page de résultats KnowledgeModel
- knowledgeModelResultPage
Obtenir la liste du schéma d’enregistrements KM
Liste des schémas d’enregistrements
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Numéro de page du résultat, commençant par 0 (première page) |
|
|
Taille de page
|
pageSize | integer |
Nombre d’éléments retournés dans une page. |
|
|
Tri
|
sort | string |
Définit la stratégie à suivre pour le tri non respect de la casse. Il doit s’agir d’un seul champ, et il doit commencer par « + » pour appliquer l’ordre ASC ou « - » pour appliquer l’ordre DESC. Un préfixe non trie asC. Le champ non existant dans l’en-tête génère une erreur |
|
|
ID du modèle de connaissances
|
km_id | True | string |
ID du modèle de connaissances |
Retours
- Page de résultats du schéma d’enregistrement
- recordSchemaResultPage
Obtenir les détails du km de niveau supérieur
Modèle de connaissances défini dans une équipe EMS
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du modèle de connaissances
|
km_id | True | string |
ID du modèle de connaissances |
Retours
Structure des données du modèle de connaissances
- Modèle de connaissances
- knowledgeModelDetailedDTO
Obtenir les détails du schéma d’enregistrement KM de niveau supérieur
Détails du schéma d’enregistrement de niveau supérieur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du modèle de connaissances
|
km_id | True | string |
ID du modèle de connaissances |
|
ID enregistrement
|
record_id | True | string |
ID enregistrement |
Retours
L’enregistrement représente un concept à l’intérieur d’un modèle de connaissances
- Type d’enregistrement
- recordDTO
Reprend l’abonnement pour commencer à recevoir de nouveaux événements, ignorer les événements d’historique
Reprend l’abonnement suspendu pour commencer à recevoir de nouveaux événements, en ignorant les événements d’historique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
L’ID d’abonnement est repris sans recevoir d’événements passés |
Reprend l’abonnement suspendu pour commencer à recevoir à nouveau des événements
Reprend l’abonnement suspendu pour commencer à recevoir à nouveau des événements
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
L’ID d’abonnement reprend et commence à recevoir à nouveau l’événement |
Récupère la page suivante des événements qui n’ont pas été transférés en raison d’un abonnement ayant échoué
Récupère la page suivante des événements s’ils n’ont pas été transférés en raison d’un abonnement ayant échoué
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
ID d’abonnement qui récupère l’événement ayant échoué envoyé, dans un maximum de 50 éléments |
Retours
- Page de résultats du signal
- SignalResultPage
Se désabonner d’un déclencheur supprimant toutes les données de l’abonnement
Se désabonner d’un déclencheur supprimant toutes les données de l’abonnement
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’abonnement
|
subscription_id | True | string |
L’ID d’abonnement sera supprimé |
Définitions
SignalResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le système |
filterDTO
Filtre à appliquer dans un km
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
description | string |
Description du filtre compréhensible par l’homme |
|
pièce d'identité
|
id | string |
Identificateur unique du filtre |
|
nom
|
name | string |
Nom d’affichage du filtre compréhensible par l’homme |
filterResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | string |
Champ utilisé pour appliquer le tri aux données demandées, + ou aucun symbole signifie ASC, - signifie DESC |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
contenu
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Structure des données du modèle de connaissances
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur unique du modèle de connaissances |
|
nom
|
name | string |
Texte compréhensible par l’homme |
|
extendedKMId
|
extendedKMId | string |
Modèle de connaissances utilisé comme référence, base KM. |
knowledgeModelResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | string |
Champ utilisé pour appliquer le tri aux données demandées, + ou aucun symbole signifie ASC, - signifie DESC |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
contenu
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Structure des données du modèle de connaissances
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur unique du modèle de connaissances |
|
nom
|
name | string |
Texte compréhensible par l’homme |
|
publié
|
published | string |
Date de publication la plus récente |
recordDTO
L’enregistrement représente un concept à l’intérieur d’un modèle de connaissances
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
description | string |
Description de l’enregistrement |
|
pièce d'identité
|
id | string |
Identificateur unique de l’enregistrement |
|
nom
|
name | string |
Nom complet de l’enregistrement, nom compréhensible par l’homme |
|
fields
|
fields | array of recordFieldDTO |
recordFieldDTO
Champs d’un enregistrement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
format
|
format | string |
Format à appliquer |
|
pièce d'identité
|
id | string |
Montant en attente de paiement |
|
nom
|
name | string |
nom compréhensible par l’homme |
|
type
|
type | string | |
|
unité
|
unit | string |
Unité ajoutée à la valeur de champ |
recordIdDTO
ID et nom du type d’enregistrement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
description | string |
Description de l’enregistrement |
|
pièce d'identité
|
id | string |
Identificateur unique de l’enregistrement |
|
nom
|
name | string |
Nom complet de l’enregistrement, nom compréhensible par l’homme |
recordItemDTO
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of |
Liste de l’élément d’enregistrement, composé avec nom et valeur |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
agrégation
|
aggregation | boolean |
Indiquez si un champ est une information agrégée/calculée(KPI). |
|
filterable
|
filterable | boolean |
Indiquez si le champ peut être filtré. |
|
format
|
format | string |
Expression de format |
|
pièce d'identité
|
id | string |
Identité de champ à utiliser dans l’analyseur de liste de champs et filterExpression param |
|
nom
|
name | string |
Texte compréhensible par l’homme |
|
sortable
|
sortable | boolean |
Indiquez si le champ peut être trié. |
|
type
|
type | string |
Types de données possibles. |
|
unité
|
unit | string |
Signe complémentaire pour la vue de la valeur de format |
recordResultPageDTO
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | array of string | |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
Élément d’enregistrement
|
content | recordItemDTO |
recordSchemaResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | string |
Champ utilisé pour appliquer le tri aux données demandées, + ou aucun symbole signifie ASC, - signifie DESC |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
contenu
|
content | array of recordIdDTO |
signalDTO
Signal stocké au niveau de l’abonnement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
signal
|
signal | string |
Json brut d’un signal |
|
subscriptionId
|
subscriptionId | string |
Identificateur unique de l’abonné en tant que SUID |
|
triggerId
|
triggerId | string |
Identificateur unique du déclencheur en tant que SUID |
|
date de création
|
creationDate | date-time |
Date de la création du signal |
subscriptionDTO
Schéma d’abonnement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
configurations
|
configurations | array of string |
Configuration de l’abonnement |
|
pièce d'identité
|
id | string |
Identificateur unique de l’abonné en tant que SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Identificateur unique du modèle de connaissances |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Date de la dernière réussite de l’événement |
|
nom
|
name | string |
Nom de l’abonnement compréhensible par l’homme |
|
status
|
status | string | |
|
triggerId
|
triggerId | string |
Identificateur unique du déclencheur en tant que SUID |
subscriptionResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | string |
Champ utilisé pour appliquer le tri aux données demandées, + ou aucun symbole signifie ASC, - signifie DESC |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
contenu
|
content | array of subscriptionDTO |
triggerDTO
Déclencheur défini au niveau du km
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur unique du déclencheur en tant que SUID |
|
nom
|
name | string |
Nom du déclencheur compréhensible par l’homme |
|
enregistrement
|
record | string |
Identificateur unique d’enregistrement en tant que SUID |
triggerResultPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page |
|
pageSize
|
pageSize | integer |
Taille de page, définie par le paramètre pageSize |
|
sort
|
sort | string |
Champ utilisé pour appliquer le tri aux données demandées, + ou aucun symbole signifie ASC, - signifie DESC |
|
total
|
total | integer |
Total des éléments retournés dans la page |
|
contenu
|
content | array of triggerDTO |
ficelle
Il s’agit du type de données de base « string ».