Lex Power Sign (préversion)
Lex Persona est un fournisseur européen de services de confiance qualifiés offrant une gamme de solutions de signature électronique. Avec Lex Enterprise, vous avez accès à tous les niveaux de signature eIDAS, ainsi qu’à un grand nombre de méthodes d’authentification du signataire. Vos livres de signature sont incorporés dans des flux de travail numériques. Automatisez les connexions entre Lex Enterprise et tous vos outils pour éliminer les tâches répétitives, gagner en efficacité et accélérer votre entreprise.
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 Lex Persona |
| URL | https://support.lex-persona.com |
| Messagerie électronique | support@lex-persona.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Lex Persona |
| Site internet | https://www.lex-persona.com |
| Politique de confidentialité | https://www.lex-persona.com/politique-de-confidentialite/ |
| Catégories | IA; Site internet |
Lex Persona est un fournisseur européen de services de confiance qualifiés offrant une gamme de solutions de signature électronique. Avec ce connecteur, vous pouvez facilement ajouter la fonctionnalité de signature électronique à votre application Microsoft (PowerApp, application web basée sur .NET, Dynamics...) et environnement (Outlook, Sharepoint, Teams...). Le connecteur est soutenu par notre Gestionnaire de flux de travail Lex Enterprise. Vous pouvez créer des flux de travail de signature electronque composés de différents types d’étapes qui peuvent s’exécuter en séquence et/ou en parallèle. Le connecteur prend en charge tous les niveaux de signature eIDAS et offre un large éventail de méthodes d’authentification de signataire (OTP, SSO, France Connect, Identité Numérique La Poste, jetons matériels...)
Prerequisites
Vous devez disposer des éléments suivants pour continuer :
- Abonnement Lex Enterprise. Utiliser le plan d’évaluation pour tester
Les exigences relatives à l’environnement sont les suivantes :
- Un plan Microsoft Power Apps ou Power Automate avec une fonctionnalité de connecteur personnalisée
- Outils CLI de la plateforme Power
Comment obtenir des informations d’identification
Veuillez contacter nos représentants commerciaux pour commercial@lex-persona.com obtenir un abonnement Lex Enteprise ou un compte sur nos systèmes d’essai.
Connectez-vous au portail Lex Enterprise avec votre compte et générez une clé API.
Bien démarrer avec votre connecteur
Tout d’abord, créez une connexion pour le connecteur. Définissez la méthode d’authentification sur la clé API, fournissez votre clé API (« Bearer act_XXXXXXX ») et spécifiez que la clé API doit être placée dans l’en-tête d’autrorisation des appels d’API.
Les étapes de création d’un flux de travail de signature simple sont les suivantes :
- juste après votre tigger, récupérez l’ID d’utilisateur Lex Enterprise connecté (cet ID est nécessaire pour créer un flux de travail) avec l’action Récupérer moi
- rechercher des pages de consentement avec les pages de consentement de recherche action_. Vous pouvez utiliser le paramètre de texte pour rechercher des pages de consentement par nom (les pages de consentement définissent le niveau de signature et sont préconfigurées dans votre environnement Lex Enterprise)
- créez un flux de travail de signature avec l’action Créer un flux de travail . Dans cette étape, vous devez fournir les informations des signataires.
- rechercher des profils de signature avec l’action Profils de signature de recherche. Vous pouvez utiliser le paramètre de texte pour rechercher des profils de signature par nom (les profils de signature contrôlent certains aspects du comportement des pages de consentement. Forcer le signataire à faire défiler vers le bas du document avant de signer par exemple)
- Récupérer un document à partir de votre environnement (Sharepoint, Outlook, OneDrive...)
- ajouter le document au flux de travail avec l’action Créer un composant , en définissant le paramètre createDocument sur true
- démarrer le flux de travail avec l’action Mettre à jour le flux de travail , en définissant l’état du flux de travailà démarrer
Veuillez noter : Le connecteur est associé par défaut à notre serveur d’évaluation. Si vous souhaitez associer le connecteur à votre propre locataire, vous devez modifier l’URL de l’hôte dans la définition de sécurité du connecteur ou dans le fichier apiDefinitions.json :
- "host": "yourtenant.lexpersona.com",
Connaître les problèmes et les limitations
L’action Créer un document accepte une liste de parties de document dans sa charge utile. Toutefois, si vous fournissez plusieurs parties, seul le premier sera pris en compte (cela est dû à un bogue dans notre API. Elle sera corrigée dans la prochaine version du connecteur.
Par conséquent, si vous souhaitez ajouter plusieurs documents à un flux de travail, il est nécessaire d’effectuer un appel à Créer un composant avec le paramètre createDocument défini sur true pour chaque document.
Erreurs courantes et solutions
En cas d’échec d’appel d’API, la réponse d’appel d’API contient un message d’erreur complet qui s’affiche dans l’historique d’exécution du connecteur. Le message contient également un ID de journal, afin que si vous avez besoin d’informations supplémentaires sur l’erreur, vous pouvez vous connecter au portail Lex Enteprise et consulter le fichier journal du serveur. Alternativley, vous pouvez configurer une demande Postman pour rechercher dans nos journaux d’activité de serveurs (plase consultez la documentation : https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Les codes d’erreur HTTP les plus courants retournés par notre API sont les suivants :
- Erreur 400 - Requête incorrecte. Il y a quelque chose de mal dans votre demande paylod. Consultez le journal pour trouver des informations sur la cause de l’erreur
- Erreur 401 : non autorisé. Yo n’a pas les droits d’accès pour effectuer cette opération. Vérifier vos droits d’accès utilisateur Lex Persona
- Erreur 403 - Interdit. Votre clé API est invlaid ou désactivée
- Erreur 404 - Introuvable. Une erreur s’affiche dans l’URL de votre demande
Vous pouvez également consulter notre documentation pour plus d’informations sur chaque appel d’API des codes d’erreur possibles (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
Questions fréquentes (FAQ)
Quels sont les formats de documents pris en charge par le connecteur
Les documents que vous pouvez envoyer pour signature peuvent avoir les formats pdf, docx, pptx et xlsx. Le connecteur convertit les documents en pdf si nécessaire et les signatures auront le format PAdES.
Il est également possible de signer des documents XML. Dans ce cas, aucune conversion n’est appliquée et les signatures ont le format XAdES.
Il est également possible de charger des fichiers zip. Le connecteur décompresse l’archive et ajoute chaque document au flux de travail.
Vous pouvez également ajouter des pièces jointes aux workflows de signatures. La pièce jointe n’est pas signée et peut avoir n’importe quel format.
Un document peut avoir plusieurs signataires
Yes. Le nombre de signataires d’un document est illimité.
Est-il possible de signer plusieurs documents à la fois
Yes. Vous pouvez ajouter plusieurs documents à un flux de travail, et tous les documents seront signés simultanément. Notez toutefois que dans ce cas, l’ensemble de documents sera juridiquement lié et que le système produira un dossier de preuves unique.
Vous pouvez également créer des workglows mutlpiple coantainissant le même signataire. Au moment de la signature, la liste des documents sera présentée au signataire et le signataire aura la possibilité de sélectionner les documents qu’elle souhaite signer. Dans ce cas, les documents seront juridiquement indépendants, et un dossier de preuve sera produit pour chaque document.
Est-il possible de signer un document hors connexion
Non. Une connexion intenet est nécessaire pour accéder aux pages de consentement.
Est-il possible d’envoyer des remiders de signature automatique aux signataires
Yes. Vous pouvez configurer la période de rappel et le nombre maximal de rappels à envoyer.
Est-il possible de modifier un flux de travail de signature déjà démarré
Yes. Avant toute signature, vous pouvez modifier tout ce qui se trouve dans le flux de travail. Après la première signature, il est impossible de modifier les documents, mais vous pouvez toujours modifier les étapes du flux de travail.
Quelle est la durée de validité des mots de passe à usage unique
La durée de validité des mots de passe à usage unique est de deux minutes (un countdow s’affiche sur les pages de consentement).
Est-il possible de vérifier la validité d’une signature électronique
Vous pouvez utiliser le volet Signatures d’Adobe Acrobat pour vérifier la validité des signatures contenues dans un document pdf. Vous pouvez également utiliser un service web de validation de signature approuvé (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation par exemple)
Quelles sont les conditions de stockage des documents Lex Persona
Par défaut, nous conservons les documents ans les fichiers de preuves dans nos serveurs. Tou peut rechercher et télécharger des documents à tout moment. Si vous le demandez, nous pouvons toutefois supprimer vos documents de nos serveurs de manière priodique.
Lex Persona conserve-t-il les jetons d’horodatage
Non. Nous ne conservons pas les jetons d’horodatage. Si nécessaire, vous pouvez extracxter ces jetons à partir des documents signés.
Existe-t-il une période de retrait pour un document signé
Yes. Le retrait dépend des conditions légales qui s’appliquent au document.
Est-il possible d’annuler un flux de travail de signature
Yes. Un utilisateur auteur peut annuler un flux de travail de signature démarré à tout moment. Aucun fichier d’evicences ne sera produit et si le document a déjà été signé par un ou plusieurs signataires, les sgnatures seront annulées.
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 |
|---|---|---|---|
| Clé d’API | securestring | Clé API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer contact |
Ajouter un contact à la liste des contacts de l’utilisateur actuel |
| Créer un document |
Créer un document à partir de composants créés précédemment |
| Créer un profil de signature |
Créer un profil de signature |
| Créer un workflow |
Créer un flux de travail |
| Créer une disposition de métadonnées |
Créer une disposition de métadonnées |
| Créer une partie |
Créer un composant de document |
| Dispositions des métadonnées de recherche |
Dispositions de flux de travail de recherche |
| Mettre à jour la disposition des métadonnées |
Mettre à jour une disposition de métadonnées |
| Mettre à jour le document |
Mettre à jour un document |
| Mettre à jour le flux de travail |
Mettre à jour un flux de travail |
| Mettre à jour le profil de signature |
Mettre à jour un profil de signature |
| Mettre à jour un contact |
Modifier des informations de contact existantes |
| Pages de consentement de recherche |
Pages de consentement de recherche |
| Profils de signature de recherche |
Profils de signature de recherche |
| Rechercher des contacts |
Rechercher des contacts |
| Rechercher des documents |
Rechercher des documents |
| Rechercher des flux de travail |
Rechercher des flux de travail |
| Récupérer la disposition des métadonnées |
Récupérer une disposition de flux de travail |
| Récupérer la page de consentement |
Récupérer les informations de page de consentement à partir de l’ID de page de consentement |
| Récupérer le contact |
Récupérer les informations de contact à partir de l’ID de contact |
| Récupérer le flux de travail |
Récupérer le flux de travail à partir de l’ID de flux de travail |
| Récupérer le mappage des métadonnées |
Récupérer le mappage des métadonnées du locataire spécifié |
| Récupérer le profil de signature |
Récupérer un profil de signature |
| Récupérer l’URL de la page constent |
Créer et récupérer l’URL de la page de consentement d’un destinataire |
| Récupérer moi |
Récupérer l’ID d’utilisateur connecté |
| Récupérer un document |
Récupérer un document |
| Supprimer le contact |
Supprimer le contact de la liste des contects de l’utilisateur actuel |
| Supprimer un document |
Supprimer un document |
| Supprimer un flux de travail |
Supprimer un flux de travail |
| Télécharger des documents de flux de travail |
Télécharger les documents de flux de travail |
| Télécharger le fichier de preuves |
Télécharger le fichier de preuves de flux de travail |
Créer contact
Ajouter un contact à la liste des contacts de l’utilisateur actuel
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant
|
userId | True | string |
Utilisateur auquel appartient le contact |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
E-mail de contact
|
True | string |
E-mail de contact |
|
|
Numéro de téléphone Contatct
|
phoneNumber | string |
numéro de téléphone |
|
|
Prénom du contact
|
firstName | True | string |
firstName |
|
Nom du contact
|
lastName | True | string |
lastName |
|
Pays de contact
|
country | string |
country |
Retours
- Corps
- contact
Créer un document
Créer un document à partir de composants créés précédemment
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail concerné |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
type de contenu
|
contentType | string |
type de contenu |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Profil de signature pour ce document |
Retours
- Corps
- document
Créer un profil de signature
Créer un profil de signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de client
|
tenantId | True | string |
ID du locataire |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Est la valeur par défaut
|
isDefault | True | string |
Fait de ce profil de signature le profil par défaut |
|
Est désactivé
|
isDisabled | string |
Désactiver ce profil de signature |
|
|
Nom
|
name | True | string |
Nom du profil de signature |
|
Type du document
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, autres |
|
Type de signature
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Forcer le défilement vers le bas du document
|
forceScrollDocument | True | boolean |
Forcer le signataire à faire défiler vers le bas du document |
|
Mode de signature visible
|
pdfVisibleSignatureMode | string |
Mode de signature visible (autorisé, désactivé, noImage) |
|
|
Texte de signature
|
pdfSignatureImageText | string |
Texte affiché dans les panneaux de signatures |
|
|
Couleur du texte de signature
|
pdfSignatureImageTextColor | string |
Couleur du texte affiché dans les pavés singatures |
|
|
Taille du texte de signature
|
pdfSignatureImageTextSize | number |
Taille du texte affiché dans les panneaux singatures |
Retours
- Corps
- signatureProfile
Créer un workflow
Créer un flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant
|
userId | True | string |
ID utilisateur du propriétaire du workflow |
|
Type de contenu
|
Content-Type | string |
Type de contenu |
|
|
Nom
|
name | True | string |
Nom du flux de travail |
|
Descriptif
|
description | string |
Description du flux de travail |
|
|
pièce d'identité
|
id | string |
ID d’étape |
|
|
stepType
|
stepType | string |
signature ou approbation |
|
|
consentPageId
|
consentPageId | True | string |
ID de la page de consentement (niveau de signature) associée à ce destinataire |
|
Messagerie électronique
|
True | string |
e-mail du destinataire |
|
|
userId
|
userId | string |
référencer un utilisateur LE au lieu de créer un destinataire à la volée |
|
|
numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone cellulaire de reicpient |
|
|
firstName
|
firstName | string |
Prénom du destinataire |
|
|
lastName
|
lastName | string |
Nom du destinataire |
|
|
country
|
country | string |
code de pays du destinataire |
|
|
preferredLocale
|
preferredLocale | string |
Code de paramètres régionaux du destinataire |
|
|
organizationId
|
organizationId | string |
ID de l’organisation LE du destinataire |
|
|
requiredRecipients
|
requiredRecipients | number |
nombre minimal de signataires qui doivent signer pour effectuer l’étape suivante |
|
|
validityPeriod
|
validityPeriod | number |
durée de validité des étapes |
|
|
inviteperiod
|
inviteperiod | number |
fréquence des rappels de signature |
|
|
maxInvites
|
maxInvites | number |
nombre maximal de rappels de signature |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
contrôle la remise du document signé aux signataires |
|
|
allowComments
|
allowComments | boolean |
autorise/interdit les commentaires sur cette étape |
|
|
hideAttachments
|
hideAttachments | boolean |
contrôle l’affichage des pièces jointes aux signataires |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
contrôle l’affichage d’autres signataires au signataire |
|
|
Événements avertis
|
notifiedEvents | array of string |
Événements de flux de travail notifiés |
|
|
userId
|
userId | string |
ID utilisateur de l’observateur |
|
|
notificationEvents
|
notifiedEvents | array of string |
Événements de flux de travail qui seront notifiés à cet observateur |
|
|
Messagerie électronique
|
string |
E-mail de l’observateur |
||
|
ID de modèle
|
templateId | string |
ID du modèle à partir duquel le flux de travail dérive |
|
|
ID de disposition
|
layoutId | string |
Disposition des métadonnées utilisée par l’objet worklow |
|
|
data1
|
data1 | string |
Premières métadonnées |
|
|
data2
|
data2 | string |
Deuxième métadonnées |
|
|
data3
|
data3 | string |
Troisième métadonnées |
|
|
data4
|
data4 | string |
Quatrième métadonnées |
|
|
data5
|
data5 | string |
Cinquième métadonnées |
|
|
data6
|
data6 | string |
Sixième métadonnées |
|
|
data7
|
data7 | string |
Septième métadonnées |
|
|
data8
|
data8 | string |
Métadonnées heighth |
Retours
- Corps
- workflow
Créer une disposition de métadonnées
Créer une disposition de métadonnées
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de client
|
tenantId | True | string |
ID de la disposition |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Nom
|
name | True | string |
Nom de la disposition |
|
Est désactivé
|
isDisabled | boolean |
Si la valeur true est définie sur true, la disposition est désactivée |
|
|
fente
|
slot | string |
Élément de métadonnées (data1 à data8) |
|
|
par défaut
|
default | string |
Valeur par défaut des métadonnées dans cette disposition |
|
|
optionnel
|
optional | boolean |
Si la valeur est true, la fourniture d’une valeur n’est pas obligatoire |
|
|
Lecture seule
|
readonly | boolean |
Wether the value can be overriden |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Si la valeur est true, la valeur persiste dans les flux de travail |
Retours
Disposition des métadonnées
- Corps
- layout
Créer une partie
Créer un composant de document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail concerné |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Cotent Disposition
|
Content-Disposition | True | string |
Content-Dispotion |
|
Créer un document
|
createDocuments | string |
Créer un document à partir de cette partie |
|
|
Ignorer les pièces jointes
|
ignoreAttachments | string |
Les pièces jointes sont ignorées |
|
|
ID de profil de signature
|
signatureProfileId | string |
Partie considérée comme pièce jointe en cas d’omission |
|
|
Décompresser
|
unzip | string |
Décompresser les fichiers |
|
|
Pdf à PdfA
|
pdf2pdfa | string |
Convertir pdf en pdf/A |
|
|
Document
|
document | True | binary |
Données de fichier chargées |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documents
|
documents | array of document |
Documents créés |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
Pièces
|
parts | array of part |
Pièces |
Dispositions des métadonnées de recherche
Dispositions de flux de travail de recherche
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
text | string |
Texte de recherche |
|
|
Recherche désactivée
|
items.isDisabled | string |
Rechercher des dispositions désactivées |
|
|
Nom de recherche
|
items.name | string |
Rechercher par nom de disposition |
|
|
Métadonnées de recherche
|
items.dataConfigurations.slot | string |
Rechercher par présence de métadonnées |
|
|
Date de création de la recherche
|
items.created | string |
Rechercher par date de création |
|
|
Date de mise à jour de la recherche
|
items.updated | string |
Rechercher par date de dernière mise à jour |
|
|
Trier par
|
sortBy | string |
Champ utilisé pour trier le résultat de la recherche |
|
|
Ordre de tri
|
sortOrder | string |
Direction du tri |
|
|
Éléments par page
|
itemsPerPage | string |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | string |
Index de la page retournée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | layouts |
Mettre à jour la disposition des métadonnées
Mettre à jour une disposition de métadonnées
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de client
|
layoutId | True | string |
ID de la disposition |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Nom
|
name | True | string |
Nom de la disposition |
|
Est désactivé
|
isDisabled | boolean |
Si la valeur true est définie sur true, la disposition est désactivée |
|
|
fente
|
slot | string |
Élément de métadonnées (data1 à data8) |
|
|
par défaut
|
default | string |
Valeur par défaut des métadonnées dans cette disposition |
|
|
optionnel
|
optional | boolean |
Si la valeur est true, la fourniture d’une valeur n’est pas obligatoire |
|
|
Lecture seule
|
readonly | boolean |
Wether the value can be overriden |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Si la valeur est true, la valeur persiste dans les flux de travail |
Retours
Disposition des métadonnées
- Corps
- layout
Mettre à jour le document
Mettre à jour un document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document Id
|
documentId | True | string |
ID du document |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
signatureProfileId
|
signatureProfileId | string |
Profil de signature à aplyer dans ce document |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Retours
- Corps
- document
Mettre à jour le flux de travail
Mettre à jour un flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail à mettre à jour |
|
Type de contenu
|
Content-Type | string |
Type de contenu |
|
|
Identifiant
|
userId | string |
ID du propriétaire du flux de travail |
|
|
Nom
|
name | string |
Nom du flux de travail |
|
|
Descriptif
|
description | string |
Description du flux de travail |
|
|
pièce d'identité
|
id | string |
ID d’étape |
|
|
stepType
|
stepType | string |
signature ou approbation |
|
|
consentPageId
|
consentPageId | True | string |
ID de la page de consentement (niveau de signature) associée à ce destinataire |
|
Messagerie électronique
|
True | string |
e-mail du destinataire |
|
|
userId
|
userId | string |
référencer un utilisateur LE au lieu de créer un destinataire à la volée |
|
|
numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone cellulaire de reicpient |
|
|
firstName
|
firstName | string |
Prénom du destinataire |
|
|
lastName
|
lastName | string |
Nom du destinataire |
|
|
country
|
country | string |
code de pays du destinataire |
|
|
preferredLocale
|
preferredLocale | string |
Code de paramètres régionaux du destinataire |
|
|
organizationId
|
organizationId | string |
ID de l’organisation LE du destinataire |
|
|
requiredRecipients
|
requiredRecipients | number |
nombre minimal de signataires qui doivent signer pour effectuer l’étape suivante |
|
|
validityPeriod
|
validityPeriod | number |
durée de validité des étapes |
|
|
inviteperiod
|
inviteperiod | number |
fréquence des rappels de signature |
|
|
maxInvites
|
maxInvites | number |
nombre maximal de rappels de signature |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
contrôle la remise du document signé aux signataires |
|
|
allowComments
|
allowComments | boolean |
autorise/interdit les commentaires sur cette étape |
|
|
hideAttachments
|
hideAttachments | boolean |
contrôle l’affichage des pièces jointes aux signataires |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
contrôle l’affichage d’autres signataires au signataire |
|
|
Événements avertis
|
notifiedEvents | array of string |
Événements de flux de travail notifiés |
|
|
userId
|
userId | string |
ID d’utilisateur observateur |
|
|
notificationEvents
|
notifiedEvents | array of string |
Événements de flux de travail qui seront notifiés à cet observateur |
|
|
Messagerie électronique
|
string |
Messagerie électronique |
||
|
État du flux de travail
|
workflowStatus | string |
État actuel du flux de travail |
|
|
data1
|
data1 | string |
premières métadonnées |
|
|
data2
|
data2 | string |
deuxième métadonnées |
|
|
data3
|
data3 | string |
troisième métadonnées |
|
|
data4
|
data4 | string |
quatrième métadonnées |
|
|
data5
|
data5 | string |
cinquième métadonnées |
|
|
data6
|
data6 | string |
sixième métadonnées |
|
|
data7
|
data7 | string |
septième métadonnées |
|
|
data8
|
data8 | string |
métadonnées heighth |
Retours
- Corps
- workflow
Mettre à jour le profil de signature
Mettre à jour un profil de signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de profil de signature
|
spId | True | string |
ID du profil de signature |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Est la valeur par défaut
|
isDefault | string |
Fait de ce profil de signature le profil par défaut |
|
|
Est désactivé
|
isDisabled | string |
Désactiver ce profil de signature |
|
|
Nom
|
name | string |
Nom du profil de signature |
|
|
Type de signature
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Forcer le défilement vers le bas du document
|
forceScrollDocument | boolean |
Forcer le signataire à faire défiler vers le bas du document |
|
|
Mode de signature visible
|
pdfVisibleSignatureMode | string |
Mode de signature visible (autorisé, désactivé, noImage) |
|
|
Texte de signature
|
pdfSignatureImageText | string |
Texte affiché dans les panneaux de signatures |
|
|
Couleur du texte de signature
|
pdfSignatureImageTextColor | string |
Couleur du texte affiché dans les pavés singatures |
|
|
Taille du texte de signature
|
pdfSignatureImageTextSize | number |
Taille du texte affiché dans les panneaux singatures |
Retours
- Corps
- signatureProfile
Mettre à jour un contact
Modifier des informations de contact existantes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | string |
ID du contact |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
E-mail du contact
|
string |
E-mail du contact |
||
|
Numéro de téléphone du contact
|
phoneNumber | string |
Numéro de téléphone du contact |
|
|
Prénom du contact
|
firstName | string |
Prénom du contact |
|
|
Nom du contact
|
lastName | string |
Nom du contact |
|
|
Pays du contact
|
country | string |
Pays du contact |
Retours
- Corps
- contact
Pages de consentement de recherche
Pages de consentement de recherche
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
text | string |
Texte de recherche |
|
|
Valeur par défaut de la recherche
|
items.isDefault | string |
Rechercher la page de consentement par défaut |
|
|
Recherche désactivée
|
items.isDisabled | string |
Rechercher des pages de consentement désactivées |
|
|
Nom de recherche
|
items.name | string |
Rechercher par nom de page de consentement |
|
|
Type d’étape de recherche
|
items.stepType | string |
Type de recherche par étape |
|
|
ID client de recherche
|
items.clientId | string |
Rechercher par ID client |
|
|
Date de création de la recherche
|
items.created | string |
Rechercher par date de création |
|
|
Date de mise à jour de la recherche
|
items.updated | string |
Rechercher par date de dernière mise à jour |
|
|
Trier par
|
sortBy | string |
Champ sur lequel trier le résultat de la recherche |
|
|
Ordre de tri
|
sortOrder | string |
Direction du tri |
|
|
Éléments par page
|
itemsPerPage | string |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | string |
Index de la page retournée |
Retours
- Corps
- consentPages
Profils de signature de recherche
Profils de signature de recherche
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
text | string |
Texte de recherche |
|
|
Valeur par défaut de la recherche
|
items.isDefault | string |
Rechercher des profils de signature par défaut |
|
|
Recherche désactivée
|
items.isDisabled | string |
Rechercher des profils de signature désactivés |
|
|
Nom de recherche
|
items.name | string |
Rechercher par nom de profil de signature |
|
|
Type de document de recherche.
|
items.documentType | string |
Rechercher par type de document |
|
|
Type de signature de recherche
|
items.signatureType | string |
Rechercher par type de signature |
|
|
Date de création de la recherche
|
items.created | string |
Rechercher par date de création |
|
|
Date de mise à jour de la recherche
|
items.updated | string |
Rechercher par date de dernière mise à jour |
|
|
Trier par
|
sortBy | string |
Champ utilisé pour trier le résultat de la recherche |
|
|
Ordre de tri
|
sortOrder | string |
Direction du tri |
|
|
Éléments par page
|
itemsPerPage | string |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | string |
Index de la page retournée |
Retours
- Corps
- signatureProfiles
Rechercher des contacts
Rechercher des contacts
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
text | string |
Rechercher par texte |
|
|
Rechercher un e-mail
|
items.email | string |
Rechercher par e-mail |
|
|
Rechercher un numéro de téléphone
|
items.phoneNumber | string |
Rechercher par numéro de téléphone |
|
|
Nom de la recherche
|
items.fisrtName | string |
Rechercher par prénom |
|
|
Nom de la recherche
|
items.lastName | string |
Rechercher par nom |
|
|
Pays de recherche
|
items.country | string |
Rechercher par pays |
|
|
Éléments par page
|
itemsPerPage | number |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | number |
Index de la page retournée |
Retours
- Corps
- contacts
Rechercher des documents
Rechercher des documents
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
text | string |
Texte de recherche |
|
|
Disposition des métadonnées de recherche
|
items.layoutId | string |
Rechercher par disposition des métadonnées |
|
|
Groupe de recherche
|
items.groupId | string |
Rechercher par groupe d’utilisateurs |
|
|
Utilisateur de recherche
|
items.userId | string |
Rechercher par propriétaire |
|
|
ID de flux de travail de recherche
|
items.workflowId | string |
Rechercher par ID de flux de travail |
|
|
Nom du flux de travail de recherche
|
items.workflowName | string |
Rechercher par nom de flux de travail |
|
|
Métadonnées de recherche 1
|
items.data1 | string |
Rechercher par valeur de métadonnées 1 |
|
|
Métadonnées de recherche 2
|
items.data2 | string |
Rechercher par valeur de métadonnées 2 |
|
|
Métadonnées de recherche 3
|
items.data3 | string |
Rechercher par valeur de métadonnées 3 |
|
|
Métadonnées de recherche 4
|
items.data4 | string |
Rechercher par valeur des métadonnées 4 |
|
|
Métadonnées de recherche 5
|
items.data5 | string |
Rechercher par valeur de métadonnées 5 |
|
|
Métadonnées de recherche 6
|
items.data6 | string |
Rechercher par valeur de métadonnées 6 |
|
|
Métadonnées de recherche 7
|
items.data7 | string |
Rechercher par valeur de métadonnées 7 |
|
|
Métadonnées de recherche 8
|
items.data8 | string |
Rechercher par valeur de métadonnées 8 |
|
|
Profil de signature de recherche
|
items.signatureProfileId | string |
Rechercher par profil de signature |
|
|
Date de création de la recherche
|
items.created | string |
Rechercher par date de création |
|
|
Date de mise à jour de la recherche
|
items.updated | string |
Rechercher par date de dernière mise à jour |
|
|
Trier par
|
sortBy | string |
Champ utilisé pour trier le résultat de la recherche |
|
|
Ordre de tri
|
sortOrder | string |
Direction du tri |
|
|
Éléments par page
|
itemsPerPage | string |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | string |
Index de la page retournée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | documents |
Rechercher des flux de travail
Rechercher des flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Accepter
|
Accept | string |
Accepter |
|
|
Texte de recherche
|
text | string |
Texte de recherche |
|
|
Disposition des métadonnées de recherche
|
items.layoutId | string |
Rechercher par disposition des métadonnées |
|
|
Modèle de recherche
|
items.templateId | string |
Rechercher par modèle de flux de travail |
|
|
Groupe de recherche
|
items.groupId | string |
Rechercher par groupe d’utilisateurs |
|
|
Utilisateur de recherche
|
items.userId | string |
Rechercher par propriétaire |
|
|
Rechercher un e-mail
|
items.email | string |
Rechercher par e-mail du propriétaire |
|
|
Nom de la recherche
|
items.firstname | string |
Rechercher par prénom du propriétaire |
|
|
Nom de la recherche
|
items.lastname | string |
Rechercher par nom de propriétaire |
|
|
État de la recherche
|
items.workflowStatus | string |
Rechercher par état du flux de travail |
|
|
Métadonnées de recherche 1
|
items.data1 | string |
Rechercher par valeur de métadonnées 1 |
|
|
Métadonnées de recherche 2
|
items.data2 | string |
Rechercher par valeur de métadonnées 2 |
|
|
Métadonnées de recherche 3
|
items.data3 | string |
Rechercher par valeur de métadonnées 3 |
|
|
Métadonnées de recherche 4
|
items.data4 | string |
Rechercher par valeur des métadonnées 4 |
|
|
Métadonnées de recherche 5
|
items.data5 | string |
Rechercher par valeur de métadonnées 5 |
|
|
Métadonnées de recherche 6
|
items.data6 | string |
Rechercher par valeur de métadonnées 6 |
|
|
Métadonnées de recherche 7
|
items.data7 | string |
Rechercher par valeur de métadonnées 7 |
|
|
Métadonnées de recherche 8
|
items.data8 | string |
Rechercher par valeur de métadonnées 8 |
|
|
Date de création de la recherche
|
items.created | string |
Rechercher par date de création |
|
|
Date de mise à jour de la recherche
|
items.updated | string |
Rechercher par date de dernière mise à jour |
|
|
Date de début de la recherche
|
items.started | string |
Rechercher par date de début |
|
|
Trier par
|
sortBy | string |
Champ utilisé pour trier le résultat de la recherche |
|
|
Ordre de tri
|
sortOrder | string |
Direction du tri |
|
|
Éléments par page
|
itemsPerPage | string |
Nombre d’éléments par page dans la réponse |
|
|
Index de page
|
pageIndex | string |
Index de la page retournée |
Retours
- Corps
- workflows
Récupérer la disposition des métadonnées
Récupérer une disposition de flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de disposition
|
layoutId | True | string |
ID de la disposition |
Retours
Disposition des métadonnées
- Corps
- layout
Récupérer la page de consentement
Récupérer les informations de page de consentement à partir de l’ID de page de consentement
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de page de consentement
|
cpId | True | string |
ID de la page de consentement |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
Retours
- Corps
- consentPage
Récupérer le contact
Récupérer les informations de contact à partir de l’ID de contact
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | string |
ID du contact |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
Retours
- Corps
- contact
Récupérer le flux de travail
Récupérer le flux de travail à partir de l’ID de flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail |
Retours
- Corps
- workflow
Récupérer le mappage des métadonnées
Récupérer le mappage des métadonnées du locataire spécifié
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de client
|
tenantId | True | string |
ID du locataire |
Retours
- Corps
- dataMapping
Récupérer le profil de signature
Récupérer un profil de signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de profil de signature
|
spId | True | string |
ID du profil de signature |
Retours
- Corps
- signatureProfile
Récupérer l’URL de la page constent
Créer et récupérer l’URL de la page de consentement d’un destinataire
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail |
|
E-mail du destinataire
|
recipientEmail | string |
E-mail du destinataire concerné |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL de la page de consentement du destinataire concerné
|
inviteUrl | string |
URL de la page de consentement du destinataire concerné |
Récupérer moi
Récupérer un document
Récupérer un document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document Id
|
documentId | True | string |
ID du document |
Retours
- Corps
- document
Supprimer le contact
Supprimer le contact de la liste des contects de l’utilisateur actuel
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | string |
ID du contact |
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
Retours
- Corps
- contact
Supprimer un document
Supprimer un document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document Id
|
documentId | True | string |
ID du document |
Retours
- Corps
- document
Supprimer un flux de travail
Supprimer un flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail à supprimer |
Retours
- Corps
- workflow
Télécharger des documents de flux de travail
Télécharger les documents de flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail |
Retours
- response
- binary
Télécharger le fichier de preuves
Télécharger le fichier de preuves de flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
workflowId | True | string |
ID du flux de travail |
|
Accepter
|
Accept | True | string |
Accepter |
Retours
- response
- binary
Définitions
consentPage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Permet l’utilisation des organisations |
|
authenticateUser
|
authenticateUser | boolean |
Impose l’authentification du signataire |
|
clientId
|
clientId | string |
ID client |
|
créé
|
created | number |
Date de création |
|
emUrl
|
emUrl | string |
URL du gestionnaire de preuves |
|
hideDownloads
|
hideDownloads | boolean |
Les liens de téléchargement de documents ne sont pas décalés sur les pages de consentement |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Masque les codes QR sur les pages constentes |
|
pièce d'identité
|
id | string |
ID de la page de consentement |
|
isCountryRequired
|
isCountryRequired | boolean |
Rend le pays obligatoire dans les informations des signataires |
|
isDisabled
|
isDisabled | boolean |
La page de consentement est désactivée |
|
logoResourceId
|
logoResourceId | string |
ID de la ressource de logo de la page de consentement |
|
nom
|
name | string |
Nom de la page de consentement |
|
primaryColor
|
primaryColor | string |
Couleur principale de la page de consentement |
|
secondaryColor
|
secondaryColor | string |
Couleur secondaire de la page de consentement |
|
sharedPassphrase
|
sharedPassphrase | string |
Phrase secrète partagée |
|
mode de signature
|
signing mode | string |
Mode de signature (local ou serveur) |
|
stepType
|
stepType | string |
type d’étape (signature ou approbation) |
|
tenantId
|
tenantId | string |
ID de client |
|
tsaUrl
|
tsaUrl | string |
URL de l’autorité d’horodatage |
|
Actualisé
|
updated | number |
Date de la dernière modification |
|
verifyEmail
|
verifyEmail | boolean |
S’il est défini sur tue, les signataires recevront des otPs par e-mail |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Si la valeur est true, les signataires recevront des otPs par sms |
consentPages
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
contacter
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
country
|
country | string |
Pays de contact |
|
créé
|
created | integer |
Date de création du contact |
|
Messagerie électronique
|
string |
E-mail de contact |
|
|
firstName
|
firstName | string |
Contact firstName |
|
pièce d'identité
|
id | string |
ID de contact |
|
lastName
|
lastName | string |
Contact lastName |
|
nom
|
name | string |
Nom du contact (prénom + nom)) |
|
numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone du contact |
|
tenantId
|
tenantId | string |
ID de client |
|
Actualisé
|
updated | integer |
Date de dernière modification du contact |
|
userId
|
userId | string |
ID du propriétaire du contact |
contacts
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
dataMapping
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
data1.description | string |
Description des métadonnées |
|
nom
|
data1.name | string |
Nom des métadonnées |
|
pattern
|
data1.pattern | string |
Modèle de métadonnées |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Valeur des métadonnées |
|
type
|
data1.type | string |
type |
|
descriptif
|
data2.description | string |
Description des métadonnées |
|
nom
|
data2.name | string |
Nom des métadonnées |
|
pattern
|
data2.pattern | string |
Modèle de métadonnées |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Valeur des métadonnées |
|
type
|
data2.type | string |
type |
|
descriptif
|
data3.description | string |
Description des métadonnées |
|
nom
|
data3.name | string |
Nom des métadonnées |
|
pattern
|
data3.pattern | string |
Modèle de métadonnées |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Valeur des métadonnées |
|
type
|
data3.type | string |
type |
|
descriptif
|
data4.description | string |
Description des métadonnées |
|
nom
|
data4.name | string |
Nom des métadonnées |
|
pattern
|
data4.pattern | string |
Modèle de métadonnées |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Valeur des métadonnées |
|
type
|
data4.type | string |
type |
|
descriptif
|
data5.description | string |
Description des métadonnées |
|
nom
|
data5.name | string |
Nom des métadonnées |
|
pattern
|
data5.pattern | string |
Modèle de métadonnées |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Valeur des métadonnées |
|
type
|
data5.type | string |
type |
|
descriptif
|
data6.description | string |
Description des métadonnées |
|
nom
|
data6.name | string |
Nom des métadonnées |
|
pattern
|
data6.pattern | string |
Modèle de métadonnées |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Valeur des métadonnées |
|
type
|
data6.type | string |
type |
|
descriptif
|
data7.description | string |
Description des métadonnées |
|
nom
|
data7.name | string |
Metadataname |
|
pattern
|
data7.pattern | string |
Modèle de métadonnées |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Metadatavalue |
|
type
|
data7.type | string |
type |
|
descriptif
|
data8.description | string |
Description des métadonnées |
|
nom
|
data8.name | string |
Nom des métadonnées |
|
pattern
|
data8.pattern | string |
Modèle de métadonnées |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Valeur des métadonnées |
|
type
|
data8.type | string |
type |
document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
créé
|
created | integer |
Date de création |
|
groupId
|
groupId | string |
ID du groupe du propriétaire du document |
|
pièce d'identité
|
id | string |
ID du document |
|
Pièces
|
parts | array of part |
Pièces |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ID du profil de signature du document |
|
tenantId
|
tenantId | string |
ID de locataire |
|
Actualisé
|
updated | integer |
Date de la dernière modification |
|
userId
|
userId | string |
ID d’utilisateur du propriétaire du document |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste des groupes autorisés à afficher le document |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Liste des utilisateurs autorisés à afficher le document |
|
workflowId
|
workflowId | string |
ID du flux de travail auquel appartient le document |
|
Nom du flux de travail
|
workflowName | string |
Nom du flux de travail auquel appartient le document |
documents
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
disposition
Disposition des métadonnées
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
créé
|
created | number |
Date de création |
|
pièce d'identité
|
id | string |
ID de disposition |
|
isDisabled
|
isDisabled | boolean |
Si la valeur true est définie sur true, la disposition a été désablable |
|
nom
|
name | string |
Nom de la disposition |
|
tenantId
|
tenantId | string |
ID du locataire |
|
Actualisé
|
updated | number |
Date de la dernière modification |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
fente
|
dataConfigurations.slot | string |
Élément de métadonnées (data1 à data8) |
|
par défaut
|
dataConfigurations.default | string |
Valeur par défaut des métadonnées dans cette disposition |
|
optionnel
|
dataConfigurations.optional | boolean |
Si la valeur est true, la fourniture d’une valeur pour ces métadonnées n’est pas obligatoire |
|
Lecture seule
|
dataConfigurations.readonly | boolean |
Wether the value can be overriden |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Si la valeur est true, la valeur persiste dans les flux de travail |
Dispositions
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
créé
|
items.created | number |
Date de création |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Nombre d’éléments par page |
|
pageIndex
|
pageIndex | number |
Index de la page retournée |
|
totalItems
|
totalItems | number |
Nombre total d’éléments concernés par la demande |
part
Composant document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type de contenu
|
contentType | string |
type de contenu |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfSigField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
créé
|
created | number |
Date de création |
|
documentType
|
documentType | string |
Type des documents |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Forcer le signataire à faire défiler vers le bas du document |
|
pièce d'identité
|
id | string |
ID de profil de signature |
|
isDefault
|
isDefault | boolean |
Fait de ce profil de signature le profil par défaut |
|
isDisabled
|
isDisabled | boolean |
Désactiver ce profil de signature |
|
nom
|
name | string |
Nom du profil de signature |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Texte affiché dans les panneaux de signatures |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Couleur du texte affiché dans les pavés singatures |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Taille du texte affiché dans les panneaux singatures |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Mode de signature visible (autorisé, désactivé, noImage) |
|
Type de signature
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
ID de client |
|
Actualisé
|
updated | number |
Date de la dernière modification |
signatureProfiles
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Nombre d’éléments par page |
|
pageIndex
|
pageIndex | number |
Index de la page retournée |
|
totalItems
|
totalItems | number |
Nombre total d’éléments concernés par la demande |
utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
approuverAllowed
|
approveAllowed | boolean |
Si la valeur est true, l’utilisateur peut approuver des documents |
|
country
|
country | string |
Pays de l’utilisateur |
|
créé
|
created | integer |
Date de création |
|
Messagerie électronique
|
string |
E-mail de l’utilisateur |
|
|
firstName
|
firstName | string |
FirstName de l’utilisateur |
|
groupId
|
groupId | string |
ID du groupe de l’utilisateur |
|
pièce d'identité
|
id | string |
Identifiant de l’utilisateur |
|
isDisabled
|
isDisabled | boolean |
Si la valeur est true, l’utilisateur est désactivé |
|
lastLogin
|
lastLogin | integer |
Date de la dernière connexion de l’utilisateur |
|
lastName
|
lastName | string |
LastName de l’utilisateur |
|
nom
|
name | string |
Nom (prénom + nom) de l’utilisateur |
|
organizationTitles
|
organizationTitles | array of |
Les fontions de l’utilisateur dans ses organisations |
|
numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone de l’utilisateur |
|
signAllowed
|
signAllowed | boolean |
Si la valeur est true, l’utilisateur peut signer des documents |
|
Objet
|
subject | string |
Code interne du sous-contenu de l’utilisateur |
|
tenantId
|
tenantId | string |
ID du locataire |
|
Actualisé
|
updated | integer |
Date de la dernière modification |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste des groupes dans lesquels l’utilisateur peut agir en tant qu’observateur |
flux de travail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
créé
|
created | integer |
créé |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Métadonnées 1 |
|
data2
|
data2 | string |
Métadonnées 2 |
|
data3
|
data3 | string |
Métadonnées 3 |
|
data4
|
data4 | string |
Métadonnées 4 |
|
data5
|
data5 | string |
Métadonnées 5 |
|
data6
|
data6 | string |
Métadonnées 6 |
|
data7
|
data7 | string |
Métadonnées 7 |
|
data8
|
data8 | string |
Métadonnées 8 |
|
descriptif
|
description | string |
Description du flux de travail |
|
Messagerie électronique
|
string |
E-mail du propriétaire du flux de travail |
|
|
firstName
|
firstName | string |
Prénom du propriétaire du flux de travail |
|
groupId
|
groupId | string |
ID du groupe du propriétaire du flux de travail |
|
pièce d'identité
|
id | string |
ID du flux de travail |
|
lastName
|
lastName | string |
Nom du propriétaire du flux de travail |
|
layoutId
|
layoutId | string |
ID de la disposition des métadonnées du flux de travail |
|
logs
|
logs | array of |
Journalise les éléments du wokflow |
|
nom
|
name | string |
Nom (prénom + nom) du propriétaire du flux de travail |
|
notificationEvents
|
notifiedEvents | array of string |
Lis des événements notifiés par le flux de travail |
|
progrès
|
progress | integer |
Progression du flux de travail en pourcentages |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Autorise/interdit les commentaires interactifs autorisés à l’étape |
|
hideAttachments
|
steps.hideAttachments | boolean |
Contrôle l’affichage des pièces jointes aux signataires |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Contrôle l’affichage d’autres signataires sur le signataire |
|
pièce d'identité
|
steps.id | string |
ID d’étape |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
destinataires
|
steps.recipients | array of object |
destinataires |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
Messagerie électronique
|
steps.recipients.email | string |
Messagerie électronique |
|
firstName
|
steps.recipients.firstName | string |
firstName |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
numéro de téléphone
|
steps.recipients.phoneNumber | string |
numéro de téléphone |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
Actualisé
|
updated | integer |
Actualisé |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste des groupes dans lesquels les utilisateurs peuvent agir en tant qu’observateurs |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
Messagerie électronique
|
watchers.email | string |
Messagerie électronique |
|
notificationEvents
|
watchers.notifiedEvents | array of string |
notificationEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
binaire
Il s’agit du type de données de base "binaire".