Agilite (préversion)
Agilit-e vous permet de centraliser votre logique métier et de les traiter et de les exposer en tant que microservices à des applications nouvelles ou existantes. Avec le connecteur Agilit-e, vous accédez à de nombreux services, notamment la gestion des processus métier (BPM), les rôles, les mots clés, les modèles et bien plus encore.
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 | Équipe du support technique Agilit-e |
| URL | https://agilite.io |
| Messagerie électronique | support@agilite.io |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Agilit-e |
| Site internet | https://agilite.io |
| Politique de confidentialité | https://agilite.io/privacy-policy/ |
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 | Partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Spécifiez l’URL du serveur d’API Agilit-e. (Utiliser «https://api.agilite.io » pour Agilit-e Cloud) | ficelle | Spécifiez l’URL du serveur d’API Agilit-e. (Utiliser «https://api.agilite.io » pour Agilit-e Cloud) | Vrai |
| Clé API (générée dans «https://portal.agilite.io » sous Administration) | securestring | Clé API (générée dans «https://portal.agilite.io » sous Administration) | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Attribuer un rôle (rôles) |
Attribuez un rôle spécifié par l’utilisateur applicable à un enregistrement spécifique. Par exemple, il s’agirait d’un réviseur de documents ou d’un approbateur de congé |
| Execute (BPM) |
Envoie une option dans son étape de flux de travail actuelle. Selon les règles d’entreprise, l’enregistrement passe à l’étape suivante du processus et retourne des informations sur l’étape suivante de l’API appelante |
| Exécuter (modèles) |
Traite et retourne un modèle à partir d’Agilit-e en fonction de la « clé de profil » fournie |
| Générer un numéro (numérotation) |
Génère un nombre unique basé sur « profile-key » fourni |
| Inscrire l’enregistrement BPM (BPM) |
Inscrivez un nouvel enregistrement BPM. L’enregistrement est affecté à un recordID utilisé pour le cycle de vie de l’enregistrement afin d’identifier l’enregistrement, sa progression, son historique et son état à tout moment |
| Obtenir des clés de profil par groupe (mots clés) |
Retourne toutes les clés de profil de mot clé en fonction du « nom de groupe » fourni |
| Obtenir des rôles attribués (rôles) |
Obtenir la ou les personnes responsables du rôle précédemment attribué pour un enregistrement spécifique |
| Obtenir la valeur par étiquette (mots clés) |
Retourne une valeur de mot clé en fonction de la « clé de profil » et de la « clé-étiquette » fournies |
| Obtenir l’état de l’enregistrement (BPM) |
Obtenir l’état d’enregistrement BPM pour un ou plusieurs enregistrements afin d’inclure l’état actuel, qui est responsable de l’enregistrement, de l’historique des flux de travail et d’autres informations pour décrire l’état actuel et les règles de l’enregistrement |
| Obtenir l’étiquette par valeur (mots clés) |
Retourne une étiquette de mot clé basée sur la « clé de profil » et la « value-key » fournie |
| Obtenir par clé de profil (BPM) |
Obtenez le profil BPM complet avec la configuration et les options du processus. |
| Obtenir par clé de profil (mots clés) |
Retourne des paires clé/valeur d’un profil de mot clé spécifique en fonction de la « clé de profil » fournie |
| Obtenir un rôle (rôles) |
Obtenez les personnes responsables qui sont affectées aux rôles dans le portail d’administration Agilit-e. Ces rôles ne sont pas seulement pertinents pour des enregistrements spécifiques ou des processus métier et sont plus généralement utilisés pour les rôles à l’échelle de l’entreprise dans l’organisation |
Attribuer un rôle (rôles)
Attribuez un rôle spécifié par l’utilisateur applicable à un enregistrement spécifique. Par exemple, il s’agirait d’un réviseur de documents ou d’un approbateur de congé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de processus
|
process-key | True | string |
Clé unique pour le profil ciblé |
|
ID d’enregistrement BPM
|
bpm-record-id | True | string |
Identifie l’enregistrement pour lequel le rôle est défini. L’ID est inscrit par l’API registerBPMRecord pour les nouveaux enregistrements et se trouve dans la propriété recordID des réponses de l’API BPM |
|
Utilisateur actuel
|
current-user | True | string |
Adresse e-mail de l’utilisateur qui définit le rôle. Il s’agit généralement de l’utilisateur connecté au moment de l’appel de l’API. |
|
Nom du rôle
|
role-name | True | string |
Nom du rôle affecté. Par exemple approbateur ou réviseur |
|
Utilisateurs responsables
|
responsible-users | True | string |
Adresses e-mail des utilisateurs affectés à ce rôle ( séparés à l’aide de virgules) |
Retours
données
- données
- object
Execute (BPM)
Envoie une option dans son étape de flux de travail actuelle. Selon les règles d’entreprise, l’enregistrement passe à l’étape suivante du processus et retourne des informations sur l’étape suivante de l’API appelante
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de processus
|
process-key | True | string |
Clé unique pour le profil ciblé |
|
ID d’enregistrement BPM
|
bpm-record-id | True | string |
Identifie l’enregistrement en cours d’envoi. L’ID est inscrit par l’API registerBPMRecord pour les nouveaux enregistrements et se trouve dans la propriété recordID des réponses de l’API BPM |
|
Option sélectionnée
|
option-selected | True | string |
Identifie l’option sélectionnée par l’utilisateur à exécuter dans le cadre du processus de soumission. Cette valeur doit correspondre à une option d’étape valide dans le profil de flux de travail |
|
Utilisateur actuel
|
current-user | True | string |
Adresse e-mail de l’utilisateur qui envoie l’étape BPM. Il s’agit généralement de l’utilisateur connecté au moment de l’appel de l’API. |
|
Commentaires de l’étape de flux de travail
|
comments | string |
Transmet les commentaires au processus d’exécution qui sera marqué dans l’historique du flux de travail. Cela est généralement utilisé si l’utilisateur rejette une étape ou demande d’informations supplémentaires |
|
|
|
object |
Retours
- Corps
- ExecuteBPMResult
Exécuter (modèles)
Traite et retourne un modèle à partir d’Agilit-e en fonction de la « clé de profil » fournie
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
|
|
object |
Retours
- Corps
- StdJSONResponse
Générer un numéro (numérotation)
Génère un nombre unique basé sur « profile-key » fourni
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
|
|
object |
Retours
- Corps
- StdJSONResponse
Inscrire l’enregistrement BPM (BPM)
Inscrivez un nouvel enregistrement BPM. L’enregistrement est affecté à un recordID utilisé pour le cycle de vie de l’enregistrement afin d’identifier l’enregistrement, sa progression, son historique et son état à tout moment
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de processus
|
process-key | True | string |
Clé unique pour le profil ciblé |
|
Utilisateur actuel
|
current-user | True | string |
Adresse e-mail de l’utilisateur qui inscrit l’enregistrement. Il s’agit généralement de l’utilisateur connecté au moment de l’appel de l’API. |
Retours
- Corps
- RegisterBPMRecord
Obtenir des clés de profil par groupe (mots clés)
Retourne toutes les clés de profil de mot clé en fonction du « nom de groupe » fourni
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du groupe
|
group-name | True | string |
Nom du groupe utilisé pour regrouper les profils de mots clés |
|
Trier
|
sort | string |
Paramètre facultatif pour trier le résultat clé/valeur retourné |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of string |
Obtenir des rôles attribués (rôles)
Obtenir la ou les personnes responsables du rôle précédemment attribué pour un enregistrement spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de processus
|
process-key | True | string |
Clé unique pour le profil ciblé |
|
ID d’enregistrement BPM
|
bpm-record-id | True | string |
Identifie l’enregistrement pour lequel le rôle est défini. L’ID est inscrit par l’API registerBPMRecord pour les nouveaux enregistrements et se trouve dans la propriété recordID des réponses de l’API BPM |
|
Nom du rôle
|
role-names | True | string |
Rôle à interroger (séparé à l’aide de virgules) |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nom
|
name | string | |
|
Users
|
users | array of object | |
|
Messagerie électronique
|
users.email | string |
Obtenir la valeur par étiquette (mots clés)
Retourne une valeur de mot clé en fonction de la « clé de profil » et de la « clé-étiquette » fournies
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
|
Clé d’étiquette
|
label-key | True | string |
Clé d’étiquette dans la liste Étiquette/Valeur du profil ciblé |
Retours
- Corps
- StdJSONResponse
Obtenir l’état de l’enregistrement (BPM)
Obtenir l’état d’enregistrement BPM pour un ou plusieurs enregistrements afin d’inclure l’état actuel, qui est responsable de l’enregistrement, de l’historique des flux de travail et d’autres informations pour décrire l’état actuel et les règles de l’enregistrement
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clés de processus
|
process-keys | string |
Filtre pour identifier la ou les processus métier auxquels les enregistrements seront retournés. Cette clé se trouve sur le profil BPM dans le portail d’administration Agilit-e ( séparée à l’aide de virgules) |
|
|
ID d’enregistrement BPM
|
bpm-record-ids | string |
filtre pour renvoyer uniquement les enregistrements avec des id d’enregistrement spécifiques. L’id d’enregistrement est inscrit par l’API registerBPMRecord pour les nouveaux enregistrements et se trouve dans la propriété recordID des réponses de l’API BPM ( séparées à l’aide de virgules) |
|
|
Noms d’étapes
|
step-names | string |
Filtrer pour renvoyer uniquement les enregistrements actuellement à l’étape(s) de flux de travail spécifiée - (séparés à l’aide de virgules) |
|
|
Utilisateurs responsables
|
responsible-users | string |
Filtrer pour renvoyer uniquement les enregistrements actuellement affectés à l’adresse e-mail spécifiée ( séparés à l’aide de virgules) |
|
|
Utilisateurs pertinents
|
relevant-users | string |
Filtrer pour renvoyer uniquement les enregistrements pertinents pour la ou les adresses e-mail spécifiées ( séparés à l’aide de virgules) |
|
|
Inclure l’historique
|
include-history | boolean |
Spécifiez si l’objet d’historique doit être retourné avec les informations d’état d’enregistrement |
|
|
Inclure les options d’étape
|
include-step-options | boolean |
Spécifiez si l’objet options d’étape doit être retourné avec les informations d’état de l’enregistrement |
|
|
Inclure des objets visibles
|
include-visible-objects | boolean |
Spécifiez si l’objet objets visibles doit être retourné avec les informations d’état de l’enregistrement |
Retours
- Objets
- GetBPMRecordState
Obtenir l’étiquette par valeur (mots clés)
Retourne une étiquette de mot clé basée sur la « clé de profil » et la « value-key » fournie
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
|
Clé de valeur
|
value-key | True | string |
Clé Valeur dans la liste Étiquette/Valeur du profil ciblé |
Retours
- Corps
- StdJSONResponse
Obtenir par clé de profil (BPM)
Obtenez le profil BPM complet avec la configuration et les options du processus.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
Retours
- Corps
- GetBPMProfile
Obtenir par clé de profil (mots clés)
Retourne des paires clé/valeur d’un profil de mot clé spécifique en fonction de la « clé de profil » fournie
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé de profil
|
profile-key | True | string |
Clé unique pour le profil ciblé |
|
Trier
|
sort | string |
Paramètre facultatif pour trier le résultat clé/valeur retourné |
Retours
- Objets
- KeywordValues
Obtenir un rôle (rôles)
Obtenez les personnes responsables qui sont affectées aux rôles dans le portail d’administration Agilit-e. Ces rôles ne sont pas seulement pertinents pour des enregistrements spécifiques ou des processus métier et sont plus généralement utilisés pour les rôles à l’échelle de l’entreprise dans l’organisation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Noms de rôles
|
role-names | True | string |
Spécifiez le ou les noms de rôle dont vous souhaitez récupérer les utilisateurs responsables : (séparés à l’aide de virgules) |
|
Niveaux conditionnels
|
conditional-levels | string |
Spécifiez des niveaux supplémentaires qui peuvent être utilisés pour déterminer la personne appropriée pour le rôle. Un exemple de niveau peut être un nom de service (si vous souhaitez récupérer le gestionnaire de services) ou un nom de produit (si vous souhaitez récupérer le Gestionnaire de produits) - (séparé à l’aide de virgules) |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Définitions
ExecuteBPMResult
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Description de l’étape de processus
|
description | string |
Brève description expliquant l’étape de processus |
|
Durée du contrat SLA (heures)
|
duration | string |
Durée du contrat SLA en heures. Indiquez la valeur 0 si elle n’est pas applicable |
|
Tampon d’événement d’étape de processus
|
eventStamp | string |
Horodatage d’événement pour l’étape de processus actuelle |
|
Instructions de l’étape
|
instructions | string |
Instructions pour l’utilisateur responsable au cours de l’étape |
|
Clé d’étape de processus
|
key | string |
Clé unique pour identifier l’étape de processus |
|
Nom de l’étape de processus
|
name | string |
Nom court de l’étape de processus |
|
Clé de profil BPM
|
processKey | string |
Clé unique pour identifier le profil BPM |
|
Phase de processus
|
processStage | string |
Clé qui définit l’étape de processus de l’étape actuelle |
|
Type de responsabilité
|
responsibility | string |
Responsabilité basée sur l’utilisateur/rôle |
|
Rôle responsable de l’étape de processus
|
responsibleRole | string |
Rôle responsable de l’étape de processus actuelle |
|
Étapes de processus utilisateurs responsables
|
responsibleUsers | array of string |
Utilisateurs responsables de l’étape de processus actuelle |
|
stepOptions
|
stepOptions | array of object | |
|
Description de l’option Étape
|
stepOptions.description | string |
Brève description expliquant l’option Étape |
|
Tampon d’événement d’option d’étape
|
stepOptions.eventStamp | array of string |
Horodatage d’événement pour l’option d’étape actuelle |
|
Nom de l’option Étape
|
stepOptions.name | string |
Nom court de l’option Étape |
|
Étape suivante
|
stepOptions.nextStep | string |
L’étape suivante consiste à router le processus métier. Laissez vide si aucune étape supplémentaire n’est effectuée |
|
Notes d’option d’étape
|
stepOptions.notes | string |
Remarques facultatives pour l’option Étape |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID d’objet De l’option d’étape
|
stepOptions.visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
stepOptions.visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet Step Option Modifiable
|
stepOptions.visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet Step Option Obligatoire
|
stepOptions.visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID d’objet étape de processus
|
visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet d’étape de processus modifiable
|
visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet étape de processus obligatoire
|
visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
GetBPMProfile
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
E-mail administrateur de l’application
|
appAdmin.email | string |
Adresse e-mail de l’administrateur du profil BPM actuel |
|
URL de l’application BPM
|
appUrl | string |
URL facultative de l’application qui utilise le profil BPM actuel |
|
Description du profil BPM
|
description | string |
Brève description expliquant le profil BPM |
|
Nom du groupe de profils BPM
|
groupName | string |
Regroupement facultatif pour le profil BPM |
|
Clé de profil BPM
|
key | string |
Clé unique pour identifier le profil BPM |
|
Nom du profil BPM
|
name | string |
Nom court pour le profil BPM |
|
Notes de profil BPM
|
notes | string |
Notes facultatives pour le profil BPM |
|
processSteps
|
processSteps | array of object | |
|
Description de l’étape de processus
|
processSteps.description | string |
Brève description expliquant l’étape de processus |
|
Durée du contrat SLA (heures)
|
processSteps.duration | string |
Durée du contrat SLA en heures. Indiquez la valeur 0 si elle n’est pas applicable |
|
Première étape
|
processSteps.firstStep | boolean |
Spécifiez si l’enregistrement étape du processus est la première étape du processus métier |
|
Instructions de l’étape
|
processSteps.instructions | string |
Instructions pour l’utilisateur responsable au cours de l’étape |
|
Clé d’étape de processus
|
processSteps.key | string |
Clé unique pour identifier l’étape de processus |
|
Nom de l’étape de processus
|
processSteps.name | string |
Nom court de l’étape de processus |
|
Phase de processus
|
processSteps.processStage | string |
Clé qui définit l’étape de processus de l’étape actuelle |
|
URL de référence de l’étape de processus
|
processSteps.referenceUrl | string |
URL de référence pour l’étape de processus |
|
Type de responsabilité
|
processSteps.responsibility | string |
Responsabilité basée sur l’utilisateur/rôle |
|
Rôle responsable de l’étape de processus
|
processSteps.responsibleRole | string |
Rôle responsable de l’étape actuelle |
|
roleLevels
|
processSteps.roleLevels | array of string |
Niveaux de rôle conditionnel |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Description de l’option Étape
|
processSteps.stepOptions.description | string |
Brève description expliquant l’option Étape |
|
Nom de l’option Étape
|
processSteps.stepOptions.name | string |
Nom court de l’option Étape |
|
Étape suivante
|
processSteps.stepOptions.nextStep | string |
L’étape suivante consiste à router le processus métier. Laissez vide si aucune étape supplémentaire n’est effectuée |
|
Notes d’option d’étape
|
processSteps.stepOptions.notes | string |
Remarques facultatives pour l’option Étape |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
ID d’objet De l’option d’étape
|
processSteps.stepOptions.visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet Step Option Modifiable
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet Step Option Obligatoire
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
ID d’objet étape de processus
|
processSteps.visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
processSteps.visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
processSteps.visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet d’étape de processus modifiable
|
processSteps.visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet étape de processus obligatoire
|
processSteps.visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
|
URL de référence du profil BPM
|
referenceUrl | string |
URL facultative qui peut être référencée pour le profil BPM actuel |
GetBPMRecordState
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Description de l’étape de processus
|
description | string |
Brève description expliquant l’étape de processus |
|
Durée du contrat SLA (heures)
|
duration | string |
Durée du contrat SLA en heures. Indiquez la valeur 0 si elle n’est pas applicable |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nom de l’historique de l’horodatage d’événement
|
eventStampHistory.eventName | string |
Nom de l’horodatage d’événements |
|
Horodatage de l’historique des horodatages d’événements
|
eventStampHistory.timeStamp | date-time |
Horodatage du moment où l’horodatage de l’événement s’est produit |
|
histoire
|
history | array of object | |
|
Commentaires d’historique
|
history.comments | string |
Commentaires facultatifs ajoutés au moment de la création de l’entrée Historique |
|
Rôle actuel d’historique
|
history.currentRole | string |
Rôle actuel au moment de l’entrée Historique |
|
Historique de l’utilisateur actuel
|
history.currentUser | string |
Utilisateur actuel au moment de l’entrée Historique |
|
Durée de l’étape
|
history.duration | string |
Heure (en minutes) où l’enregistrement existait à l’étape de processus en cours avant d’être actionné |
|
Horodatage de l’événement d’historique
|
history.eventStamp | array of string |
Horodatages d’événements qui se sont produits au moment de l’entrée Historique |
|
À partir de l’étape
|
history.fromStep | string |
La clé de l’étape de processus de l’enregistrement BPM provient à l’heure de l’entrée Historique |
|
À partir du nom de l’étape
|
history.fromStepName | string |
Le nom de l’étape de processus dont l’enregistrement BPM provient à l’heure de l’entrée Historique |
|
Option d’historique sélectionnée
|
history.optionSelected | string |
Option sélectionnée lors de l’action de l’enregistrement BPM |
|
Historique de la clé de processus BPM
|
history.processKey | string |
Clé de processus BPM unique pour l’entrée Historique |
|
Étape du processus d’historique
|
history.processStage | string |
Étape processus au moment de l’entrée Historique |
|
Id d’enregistrement BPM d’historique
|
history.recordId | string |
ID d’enregistrement de l’enregistrement associé BPM généré pendant le processus d’enregistrement BPM |
|
Rôle responsable de l’historique
|
history.responsibleRole | string |
Rôle responsable de l’enregistrement BPM au moment de l’entrée Historique |
|
Historique des utilisateurs responsables
|
history.responsibleUsers | array of string |
Utilisateur(s) responsable(s) au moment de l’entrée Historique |
|
Date de soumission de l’historique
|
history.submissionDate | date-time |
Date/heure d’action de l’enregistrement BPM |
|
Pour traiter l’étape
|
history.toProcessStage | string |
Étape processus de l’enregistrement BPM au moment de l’entrée Historique |
|
À l’étape
|
history.toStep | string |
Clé de l’étape de processus pour l’enregistrement BPM au moment de l’entrée Historique |
|
Pour le nom de l’étape
|
history.toStepName | string |
Nom de l’étape de processus pour l’enregistrement BPM au moment de l’entrée Historique |
|
Instructions de l’étape
|
instructions | string |
Instructions pour l’utilisateur responsable au cours de l’étape |
|
Clé d’étape de processus
|
key | string |
Clé unique pour identifier l’étape de processus |
|
Nom de l’étape de processus
|
name | string |
Nom court de l’étape de processus |
|
Clé de profil BPM
|
processKey | string |
Clé unique pour identifier le profil BPM |
|
Phase de processus
|
processStage | string |
Clé qui définit l’étape de processus de l’étape actuelle |
|
ID d’enregistrement BPM
|
recordId | string |
ID d’enregistrement généré par le module BPM lors de l’inscription d’un enregistrement BPM |
|
Référence d’enregistrement BPM
|
recordRef | string |
Nombre lisible généré par le module BPM à l’aide du module Numérotation lors de l’inscription d’un enregistrement BPM |
|
URL de référence de l’étape de processus
|
referenceUrl | string |
URL de référence pour l’étape de processus |
|
Rôle responsable de l’étape de processus
|
responsibleRole | string |
Rôle responsable de l’étape actuelle |
|
Étapes de processus utilisateurs responsables
|
responsibleUsers | array of string |
Utilisateur(s) responsable(s) de l’étape de processus en cours |
|
roles
|
roles | array of object | |
|
Nom du rôle
|
roles.name | string |
Nom du rôle |
|
users
|
roles.users | array of object | |
|
E-mail de rôle
|
roles.users.email | string |
Adresse(s) de messagerie liée au nom du rôle |
|
stepOptions
|
stepOptions | array of object | |
|
Description de l’option Étape
|
stepOptions.description | string |
Brève description expliquant l’option Étape |
|
Tampon d’événement d’option d’étape
|
stepOptions.eventStamp | array of string |
Horodatage d’événement pour l’option d’étape actuelle |
|
Nom de l’option Étape
|
stepOptions.name | string |
Nom court de l’option Étape |
|
Étape suivante
|
stepOptions.nextStep | string |
L’étape suivante consiste à router le processus métier. Laissez vide si aucune étape supplémentaire n’est effectuée |
|
Notes d’option d’étape
|
stepOptions.notes | string |
Remarques facultatives pour l’option Étape |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID d’objet De l’option d’étape
|
stepOptions.visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
stepOptions.visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet Step Option Modifiable
|
stepOptions.visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet Step Option Obligatoire
|
stepOptions.visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
|
Soumis à l’étape
|
submittedIntoStep | date-time |
Date/heure à laquelle l’enregistrement BPM a été envoyé à l’étape de processus en cours |
|
Durée cible
|
targetTimeDuration | date-time |
La date/heure à laquelle l’enregistrement BPM doit être actionné en fonction de la durée du contrat SLA |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID d’objet étape de processus
|
visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet d’étape de processus modifiable
|
visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet étape de processus obligatoire
|
visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
KeywordValues
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquette
|
label | string | |
|
Valeur
|
value | string |
RegisterBPMRecord
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Description de l’étape de processus
|
description | string |
Brève description expliquant l’étape de processus |
|
Durée du contrat SLA (heures)
|
duration | string |
Durée du contrat SLA en heures. Indiquez la valeur 0 si elle n’est pas applicable |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nom de l’historique de l’horodatage d’événement
|
eventStampHistory.eventName | string |
Nom de l’horodatage d’événements |
|
Horodatage de l’historique des horodatages d’événements
|
eventStampHistory.timeStamp | date-time |
Horodatage du moment où l’horodatage de l’événement s’est produit |
|
histoire
|
history | array of object | |
|
Commentaires d’historique
|
history.comments | string |
Commentaires facultatifs ajoutés au moment de la création de l’entrée Historique |
|
Rôle actuel d’historique
|
history.currentRole | string |
Rôle actuel au moment de l’entrée Historique |
|
Historique de l’utilisateur actuel
|
history.currentUser | string |
Utilisateur actuel au moment de l’entrée Historique |
|
Durée de l’étape
|
history.duration | string |
Heure (en minutes) où l’enregistrement existait à l’étape de processus en cours avant d’être actionné |
|
Horodatage de l’événement d’historique
|
history.eventStamp | array of string |
Horodatages d’événements qui se sont produits au moment de l’entrée Historique |
|
À partir de l’étape
|
history.fromStep | string |
La clé de l’étape de processus de l’enregistrement BPM provient à l’heure de l’entrée Historique |
|
À partir du nom de l’étape
|
history.fromStepName | string |
Le nom de l’étape de processus dont l’enregistrement BPM provient à l’heure de l’entrée Historique |
|
Option d’historique sélectionnée
|
history.optionSelected | string |
Option sélectionnée lors de l’action de l’enregistrement BPM |
|
Historique de la clé de processus BPM
|
history.processKey | string |
Clé de processus BPM unique pour l’entrée Historique |
|
Étape du processus d’historique
|
history.processStage | string |
Étape processus au moment de l’entrée Historique |
|
Id d’enregistrement BPM d’historique
|
history.recordId | string |
ID d’enregistrement de l’enregistrement associé BPM généré pendant le processus d’enregistrement BPM |
|
Rôle responsable de l’historique
|
history.responsibleRole | string |
Rôle responsable de l’enregistrement BPM au moment de l’entrée Historique |
|
Historique des utilisateurs responsables
|
history.responsibleUsers | array of string |
Utilisateur(s) responsable(s) au moment de l’entrée Historique |
|
Date de soumission de l’historique
|
history.submissionDate | date-time |
Date/heure d’action de l’enregistrement BPM |
|
Pour traiter l’étape
|
history.toProcessStage | string |
Étape processus de l’enregistrement BPM au moment de l’entrée Historique |
|
À l’étape
|
history.toStep | string |
Clé de l’étape de processus pour l’enregistrement BPM au moment de l’entrée Historique |
|
Pour le nom de l’étape
|
history.toStepName | string |
Nom de l’étape de processus pour l’enregistrement BPM au moment de l’entrée Historique |
|
Instructions de l’étape
|
instructions | string |
Instructions pour l’utilisateur responsable au cours de l’étape |
|
Clé d’étape de processus
|
key | string |
Clé unique pour identifier l’étape de processus |
|
Nom de l’étape de processus
|
name | string |
Nom court de l’étape de processus |
|
Clé de profil BPM
|
processKey | string |
Clé unique pour identifier le profil BPM |
|
Phase de processus
|
processStage | string |
Clé qui définit l’étape de processus de l’étape actuelle |
|
ID d’enregistrement BPM
|
recordId | string |
ID d’enregistrement généré par le module BPM lors de l’inscription d’un enregistrement BPM |
|
Référence d’enregistrement BPM
|
recordRef | string |
Nombre lisible généré par le module BPM à l’aide du module Numérotation lors de l’inscription d’un enregistrement BPM |
|
URL de référence de l’étape de processus
|
referenceUrl | string |
URL de référence pour l’étape de processus |
|
Rôle responsable de l’étape de processus
|
responsibleRole | string |
Rôle responsable de l’étape de processus actuelle |
|
Étapes de processus utilisateurs responsables
|
responsibleUsers | array of string |
Utilisateurs responsables de l’étape de processus actuelle |
|
roles
|
roles | array of object | |
|
Nom du rôle
|
roles.name | string |
Nom du rôle |
|
users
|
roles.users | array of object | |
|
E-mail de rôle
|
roles.users.email | string |
Adresse(s) de messagerie liée au nom du rôle |
|
stepOptions
|
stepOptions | array of object | |
|
Description de l’option Étape
|
stepOptions.description | string |
Brève description expliquant l’option Étape |
|
Tampon d’événement d’option d’étape
|
stepOptions.eventStamp | array of string |
Horodatage d’événement pour l’option d’étape actuelle |
|
Nom de l’option Étape
|
stepOptions.name | string |
Nom court de l’option Étape |
|
Étape suivante
|
stepOptions.nextStep | string |
L’étape suivante consiste à router le processus métier. Laissez vide si aucune étape supplémentaire n’est effectuée |
|
Notes d’option d’étape
|
stepOptions.notes | string |
Remarques facultatives pour l’option Étape |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID d’objet De l’option d’étape
|
stepOptions.visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
stepOptions.visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
stepOptions.visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet Step Option Modifiable
|
stepOptions.visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet Step Option Obligatoire
|
stepOptions.visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID d’objet étape de processus
|
visibleObjects.id | string |
ID du composant qui est référencé dans l’interface utilisateur |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Choix d’étiquette de type
|
visibleObjects.inputOptions.choices.label | string |
Étiquette pour le choix sélectionné |
|
Choix , valeur de type
|
visibleObjects.inputOptions.choices.value | string |
Valeur pour le choix sélectionné |
|
Étiquette options d’entrée
|
visibleObjects.inputOptions.label | string |
Étiquette définissant le champ d’entrée ou composant modifiable |
|
Messages d’options d’entrée
|
visibleObjects.inputOptions.messages | array of string |
Messages à utiliser lorsque la validation des options d’entrée échoue |
|
Type d’options d’entrée
|
visibleObjects.inputOptions.type | string |
Définit le type de champ d’entrée ou composant modifiable à utiliser |
|
Objet d’étape de processus modifiable
|
visibleObjects.isEditable | boolean |
Le composant référencé peut-il être modifié pour l’entrée utilisateur |
|
Objet étape de processus obligatoire
|
visibleObjects.isMandatory | boolean |
Le composant référencé nécessite-t-il une entrée utilisateur |
StdJSONResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Résultat
|
result | string |
Résultat |
objet
Il s’agit du type "objet".