Redque (préversion)
Accès et gestion du système Redque.
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 | Redque s.r.o. |
| URL | https://redque.com |
| Messagerie électronique | info@redque.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Redque s.r.o. |
| Website | https://redque.cz/en/ |
| Politique de confidentialité | https://redque.cz/policy.html |
| Catégories | IA; Finance |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Accorder l’accès au document à l’utilisateur spécifié |
Accorde l’accès au document à l’utilisateur spécifié. |
| Ajouter des autorisations |
Ajoute des autorisations à l’utilisateur. |
| Charger un document et le planifier pour le traitement |
Charge le document et le planifie pour le traitement. |
| Créer un dossier |
Crée un dossier. |
| Créer un utilisateur |
Crée un utilisateur. |
| Créer une énumération |
Notez que la clé d’énumération est générée automatiquement et que les clés de valeur doivent contenir uniquement des lettres minuscules, des lettres majuscules, des chiffres, un trait de soulignement, un tiret |
| Dossier de téléchargement |
Télécharge tous les documents d’un dossier sous forme d’archive unique. |
| Déverrouiller le document verrouillé |
Déverrouille le document verrouillé (ferme) pour permettre à d’autres utilisateurs de modifier son contenu. |
| Extraire le document |
Demande l’extraction d’un document. Une fois le document récupéré, il est planifié pour suppression. |
| Filtrer les documents |
Retourne la liste des documents en fonction des paramètres. |
| Filtrer les utilisateurs |
Obtient la liste des utilisateurs par critères. |
| Générer un jeton |
Génère un nouveau jeton d’inscription. |
| Image d’une page donnée |
Retourne une image pour une page donnée. |
| Informations de licence |
Retourne les informations de licence. |
| Jeton de retour |
Retourne le jeton d’inscription actuel ou rien si le jeton n’est pas actif. |
| Mettre à jour l'utilisateur |
Met partiellement à jour un utilisateur spécifié. |
| Mettre à jour la configuration de l’expéditeur |
Les mises à jour retournent à la configuration de l’expéditeur. |
| Mettre à jour le document |
Met à jour le document. |
| Mettre à jour les données du dossier |
Met à jour les données du dossier. |
| Mettre à jour l’énumération spécifique |
Met à jour une énumération spécifique. |
| Modifier le mot de passe |
Modifie le mot de passe de l’utilisateur. |
| Modifier le mot de passe de l’utilisateur |
Modifie le mot de passe de l’utilisateur spécifié. Nécessite l’autorisation de gestion des utilisateurs. |
| Obtenir les métadonnées du document |
Obtient les métadonnées du document. |
| Obtenir un document extrait |
Le document extrait est marqué pour suppression et sera supprimé dans les quelques heures suivant l’accès. Cela permet aux utilisateurs de réessayer de récupérer le résultat en cas d’échec. |
| Rechercher un dossier |
Recherche le dossier par ID. |
| Rechercher un utilisateur |
Recherche un utilisateur. |
| Retourner le document à l’émetteur pour les corrections |
Retourne le document à l’émetteur pour les corrections à l’adresse de messagerie fournie. |
| Retourner l’énumération |
Retourne une énumération spécifique. |
| Retourner toutes les énumérations |
Retourne la liste de toutes les énumérations. |
| Revenir à la configuration de l’expéditeur |
Récupérez la configuration actuelle pour revenir à l’action d’expéditeur. |
| Supprime le jeton |
Supprime le jeton d’inscription. |
| Supprime l’énumération avec un ID spécifique |
Supprime une énumération spécifique. |
| Supprimer le dossier |
Supprime le dossier existant. |
| Supprimer les autorisations |
Révoque les autorisations de l’utilisateur. |
| Supprimer l’accès au document pour l’utilisateur spécifié |
Supprime l’accès au document pour l’utilisateur spécifié. |
| Supprimer l’utilisateur |
Supprime un utilisateur. |
| Supprimer un document existant |
Supprime le document existant. |
| Télécharger le fichier du document |
Télécharge le fichier du document. |
| Verrouiller le document |
Verrouille (ouvre) le document empêchant les autres utilisateurs de le modifier. |
Accorder l’accès au document à l’utilisateur spécifié
Accorde l’accès au document à l’utilisateur spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur |
|
documentId
|
documentId | string |
ID de document |
|
|
userId
|
userId | string |
Identifiant utilisateur |
|
|
Message
|
message | string |
Ajouter des autorisations
Ajoute des autorisations à l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant de l’utilisateur |
|
permissions
|
permissions | array of string |
Accéder aux données |
Charger un document et le planifier pour le traitement
Charge le document et le planifie pour le traitement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Fichier
|
File | file |
Fichier |
|
|
ID externe du document
|
DocumentId | string |
ID de document externe |
|
|
ID du dossier
|
FolderId | string |
ID de dossier |
|
|
Date
|
Date | date-time |
Date |
|
|
JSON
|
Ordinal | integer |
Ordre utilisé pour conserver l’ordre des documents qui sont chargés en parallèle |
|
|
Document d’une pièce jointe
|
IsAttachment | boolean |
True si le document est une pièce jointe |
|
|
Classe document
|
DocumentClass | string |
Classe document |
Retours
Résultat d’un chargement de fichier
- Corps
- ApiUploadResponse
Créer un dossier
Créer un utilisateur
Crée un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
firstName
|
firstName | string |
Prénom de l’utilisateur |
|
|
lastName
|
lastName | string |
Nom de l’utilisateur |
|
|
mot de passe
|
password | string |
Mot de passe du compte |
|
|
Messagerie électronique
|
string |
Adresse e-mail (nom de connexion) de l’utilisateur |
Créer une énumération
Notez que la clé d’énumération est générée automatiquement et que les clés de valeur doivent contenir uniquement des lettres minuscules, des lettres majuscules, des chiffres, un trait de soulignement, un tiret
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur d’énumération |
|
|
nom
|
name | string |
Nom d’énumération convivial |
|
|
values
|
values | object |
Liste des valeurs d’énumération |
|
|
isEditable
|
isEditable | boolean |
Indique si l’énumération peut être modifiée |
Retours
Valeur de réponse générique
- Corps
- StringApiValue
Dossier de téléchargement
Télécharge tous les documents d’un dossier sous forme d’archive unique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier
|
folderId | True | string |
Identificateur de dossier |
Déverrouiller le document verrouillé
Déverrouille le document verrouillé (ferme) pour permettre à d’autres utilisateurs de modifier son contenu.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Extraire le document
Demande l’extraction d’un document. Une fois le document récupéré, il est planifié pour suppression.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
externalDocumentId | string |
ID de document (facultatif - VOTRE ID de document externe) |
|
|
Fichier
|
file | file |
Fichier |
Filtrer les documents
Retourne la liste des documents en fonction des paramètres.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
texte
|
text | string |
Texte de recherche utilisé pour les recherches générales |
|
|
value
|
value | string | ||
|
values
|
values | string |
État du document |
|
|
values
|
values | string |
État du document |
|
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
de
|
from | date-time | ||
|
à
|
to | date-time | ||
|
fields
|
fields | object |
Filtres de champs |
|
|
skip
|
skip | integer |
Nombre d’éléments à ignorer à partir du début de la liste. Autorise la pagination. |
|
|
take
|
take | integer |
Nombre maximal d’éléments de liste qui seront retournés |
|
|
field
|
field | string |
Liste des propriétés sur lesquelles les résultats peuvent être triés |
|
|
direction
|
direction | string |
Direction dans laquelle les valeurs de liste sont triées |
|
|
scopes
|
scopes | string |
Étendue du document qui filtre les parties du document à retourner |
Retours
Résultat de la recherche
- Corps
- ApiDocumentApiListResult
Filtrer les utilisateurs
Obtient la liste des utilisateurs par critères.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
texte
|
text | string |
Texte de recherche utilisé pour les recherches générales |
|
|
value
|
value | string | ||
|
skip
|
skip | integer |
Nombre d’éléments à ignorer à partir du début de la liste. Autorise la pagination. |
|
|
take
|
take | integer |
Nombre maximal d’éléments de liste qui seront retournés |
|
|
field
|
field | string |
Énumération pour la déclaration des paramètres de tri de l’utilisateur |
|
|
direction
|
direction | string |
Direction dans laquelle les valeurs de liste sont triées |
Retours
Résultat de la recherche
- Corps
- ApiUserApiListResult
Générer un jeton
Image d’une page donnée
Retourne une image pour une page donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
Index de page
|
pageIndex | True | integer |
Index de page |
|
Preview
|
isPreview | boolean |
True si l’image de taille réduite doit être retournée. |
Retours
- response
- uri
Informations de licence
Jeton de retour
Retourne le jeton d’inscription actuel ou rien si le jeton n’est pas actif.
Retours
Valeur de réponse générique
- Corps
- StringApiValue
Mettre à jour l'utilisateur
Met partiellement à jour un utilisateur spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant utilisateur |
|
firstName
|
firstName | string |
Prénom de l’utilisateur |
|
|
lastName
|
lastName | string |
Nom de l’utilisateur |
Mettre à jour la configuration de l’expéditeur
Les mises à jour retournent à la configuration de l’expéditeur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
modèle
|
template | string | ||
|
Objet
|
subject | string |
Mettre à jour le document
Met à jour le document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document Id |
|
documentId
|
documentId | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
value
|
value | boolean | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
opération
|
operation | string | ||
|
key
|
key | string | ||
|
Message
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
value
|
value | string | ||
|
opération
|
operation | string | ||
|
key
|
key | string | ||
|
Message
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
userId
|
userId | string | ||
|
userId
|
userId | string | ||
|
état
|
state | string |
État du document |
|
|
value
|
value | string | ||
|
opération
|
operation | string | ||
|
value
|
value | string | ||
|
opération
|
operation | string |
Retours
Données de réponse d’état. Utilisé comme réponse lorsque la requête ne retourne aucune donnée.
- Corps
- RedQueStatus
Mettre à jour les données du dossier
Met à jour les données du dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier
|
folderId | True | string |
ID de dossier |
|
folderId
|
folderId | string |
ID de document. |
|
|
ownerId
|
ownerId | string |
ID du propriétaire du conteneur |
|
|
créé
|
created | date-time |
Heure de création du conteneur |
|
|
metadata
|
metadata | object |
Tous les en-têtes attachés au conteneur |
Mettre à jour l’énumération spécifique
Met à jour une énumération spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur d’énumération
|
id | True | string |
Identificateur d’énumération |
|
pièce d'identité
|
id | string |
Identificateur d’énumération |
|
|
nom
|
name | string |
Nom d’énumération convivial |
|
|
values
|
values | object |
Liste des valeurs d’énumération |
|
|
isEditable
|
isEditable | boolean |
Indique si l’énumération peut être modifiée |
Modifier le mot de passe
Modifie le mot de passe de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant de l’utilisateur |
|
body
|
body | string |
Mot de passe de l’utilisateur |
Modifier le mot de passe de l’utilisateur
Modifie le mot de passe de l’utilisateur spécifié. Nécessite l’autorisation de gestion des utilisateurs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant de l’utilisateur |
|
mot de passe
|
password | string |
Mot de passe de l’utilisateur |
|
|
accountId
|
accountId | string |
ID de compte de l’utilisateur |
|
|
activationkey
|
activationkey | string |
Clé d’activation de l’utilisateur |
Obtenir les métadonnées du document
Obtient les métadonnées du document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ID de document |
|
L’ID de document est-il un ID externe ?
|
isExternalId | boolean |
L’ID de document est-il un ID externe ? |
Retours
- Corps
- ApiDocument
Obtenir un document extrait
Le document extrait est marqué pour suppression et sera supprimé dans les quelques heures suivant l’accès. Cela permet aux utilisateurs de réessayer de récupérer le résultat en cas d’échec.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
id | True | string |
ID de document (fourni par RedQue ou externe) |
Rechercher un dossier
Recherche le dossier par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier
|
folderId | True | string |
Identificateur de dossier |
|
Avec les membres
|
withMembers | boolean |
True si le document avec des membres |
Retours
Métadonnées de conteneur avec métadonnées de documents à l’intérieur du conteneur
- Corps
- ApiFolderWithMembers
Rechercher un utilisateur
Recherche un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant de l’utilisateur |
Retours
Informations utilisateur
- Corps
- ApiUser
Retourner le document à l’émetteur pour les corrections
Retourne le document à l’émetteur pour les corrections à l’adresse de messagerie fournie.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
additionalDocuments
|
additionalDocuments | array of string | ||
|
recipientEmail
|
recipientEmail | string | ||
|
reason
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
Retourner l’énumération
Retourne une énumération spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur d’énumération
|
id | True | string |
Identificateur d’énumération |
Retours
Données d’énumération pour l’énumération de type de champ
- Corps
- ApiEnum
Retourner toutes les énumérations
Revenir à la configuration de l’expéditeur
Récupérez la configuration actuelle pour revenir à l’action d’expéditeur.
Supprime le jeton
Supprime le jeton d’inscription.
Supprime l’énumération avec un ID spécifique
Supprime une énumération spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Clé d’énumération
|
id | True | string |
Identificateur/clé d’énumération |
Supprimer le dossier
Supprime le dossier existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier
|
folderId | True | string |
Identificateur de dossier |
Supprimer les autorisations
Révoque les autorisations de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant de l’utilisateur |
|
permissions
|
permissions | array of string |
Accéder aux données |
Supprimer l’accès au document pour l’utilisateur spécifié
Supprime l’accès au document pour l’utilisateur spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Identificateur de document |
|
ID d’utilisateur
|
userId | True | string |
Identificateur de l’utilisateur |
Supprimer l’utilisateur
Supprime un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identifiant |
Supprimer un document existant
Supprime le document existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ID de document |
Télécharger le fichier du document
Télécharge le fichier du document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Identificateur de document |
Verrouiller le document
Verrouille (ouvre) le document empêchant les autres utilisateurs de le modifier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Définitions
ApiApproval
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Approbateur
|
approver | ApiUser |
Informations utilisateur |
|
approvalStepTime
|
approvalStepTime | date-time |
Temps d’affectation à l’approbateur actuel'. |
|
approvalState
|
approvalState | ApprovalState |
État du document |
|
déléguédTo
|
delegatedTo | ApiUser |
Informations utilisateur |
|
note
|
note | string |
Note d’approbateur |
ApiApprovalReminder
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
Informations utilisateur |
|
toUser
|
toUser | ApiUser |
Informations utilisateur |
|
sentTime
|
sentTime | date-time |
Heure d’envoi |
|
note
|
note | string |
Note d’urgence |
ApiDocument
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
ID de document |
|
externalDocumentId
|
externalDocumentId | string |
ID de document externe |
|
folderId
|
folderId | string |
ID de conteneur de documents |
|
contentHash
|
contentHash | string |
Hachage du contenu |
|
pageCount
|
pageCount | integer |
Nombre total de pages dans le document, le premier index est 1. Ce nombre peut ne pas être égal au nombre de pages, car si le document comporte trop de pages, certains d’entre eux peuvent être ignorés en raison de raisons de performances |
|
fileName
|
fileName | string |
Nom du fichier du document |
|
owner
|
owner | ApiUser |
Informations utilisateur |
|
état
|
state | DocumentState |
État du document |
|
erreur
|
error | string |
Code d’erreur du document |
|
isImagesGenerated
|
isImagesGenerated | boolean |
Des images ont été générées |
|
isReturned
|
isReturned | boolean |
True si les documents ont été renvoyés à l’expéditeur. |
|
returnReason
|
returnReason | string |
Motif du retour. |
|
creationTime
|
creationTime | date-time |
Date de création |
|
size
|
size | integer |
Taille du document en Ko |
|
type de contenu
|
contentType | string |
Type de contenu |
|
Source
|
source | DocumentSource | |
|
sourceInfo
|
sourceInfo | string |
Détails de la source (en adresse e-mail générale) |
|
extractionTime
|
extractionTime | date-time |
Date de classification |
|
model
|
model | string |
Type de ce document |
|
isAttachment
|
isAttachment | boolean |
Indique si le document est une pièce jointe |
|
isValidated
|
isValidated | boolean |
Indicateur si le document a été validé |
|
isEdited
|
isEdited | boolean |
Indicateur, si ce document a été modifié (au moins un champ, une note ou une balise a été modifié) |
|
note
|
note | string |
Note d’utilisateur personnalisée |
|
fields
|
fields | object |
Liste des champs extraits |
|
items
|
items | array of object |
Liste des éléments extraits |
|
items
|
items | object | |
|
Pages
|
pages | array of ApiPage |
Liste de toutes les pages qui font partie d’une extraction. |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Résultats généraux |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
Indicateur, si le post-traitement est terminé |
|
isPrevalidated
|
isPrevalidated | boolean |
Indique si un document contient des scripts pp de prévalidation |
|
lastOpenTime
|
lastOpenTime | date-time |
Dernière date d’ouverture |
|
lastOpenUserId
|
lastOpenUserId | string |
ID de l’utilisateur qui a ouvert ce document pour la dernière fois |
|
isLocked
|
isLocked | boolean |
Détermine si le document est verrouillé ou non |
|
validationTime
|
validationTime | date-time |
Heure à laquelle le document a été validé |
|
version
|
version | integer |
Numéro de version, incrémenté avec chaque mise à jour |
|
approvalState
|
approvalState | ApprovalState |
État du document |
|
currentApproverId
|
currentApproverId | string |
ID de l’utilisateur qui doit approuver ce document |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
Temps d’affectation à l’approbateur actuel |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
La notification a été envoyée à l’approbateur actuel |
|
approvalHistory
|
approvalHistory | array of ApiApproval |
Historique d’approbation |
|
approvalReminderHistory
|
approvalReminderHistory | array of ApiApprovalReminder |
Approuver l’historique |
|
allowedUserIds
|
authorizedUserIds | array of string |
Utilisateurs autorisés à accéder au document |
|
duplicateDocIds
|
duplicateDocIds | array of string |
ID de document en double (en fonction des valeurs de champs) |
|
approvedBy
|
approvedBy | ApiUser |
Informations utilisateur |
|
validatedBy
|
validatedBy | ApiUser |
Informations utilisateur |
ApiDocumentApiListResult
Résultat de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
list
|
list | array of ApiDocument |
Liste de toutes les valeurs trouvées |
|
hasMore
|
hasMore | boolean |
True si la recherche peut retourner d’autres valeurs |
|
offset
|
offset | integer |
Valeur de décalage (nombre de valeurs ignorées) |
ApiEnum
Données d’énumération pour l’énumération de type de champ
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur d’énumération |
|
nom
|
name | string |
Nom d’énumération convivial |
|
values
|
values | object |
Liste des valeurs d’énumération |
|
isEditable
|
isEditable | boolean |
Indique si l’énumération peut être modifiée |
ApiFolderCreationResult
Résultat de la création d’un conteneur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID de conteneur |
ApiFolderWithMembers
Métadonnées de conteneur avec métadonnées de documents à l’intérieur du conteneur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID de document. |
|
ownerId
|
ownerId | string |
ID du propriétaire du conteneur |
|
créé
|
created | date-time |
Heure de création du conteneur |
|
metadata
|
metadata | object |
Tous les en-têtes attachés au conteneur |
|
membres
|
members | array of ApiDocument |
Liste de tous les membres du conteneur |
ApiItemCell
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | string |
Valeur de cellule |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
Indique si cette valeur a été modifiée par post-traitement |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Résultats des plug-ins |
ApiItemColumn
Définit la colonne de table d’éléments.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
field
|
field | string |
Terrain |
|
width
|
width | double |
Hauteur de la ligne. |
ApiItemRow
Définit la ligne du tableau d’éléments.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
height
|
height | double |
Hauteur de la ligne. |
|
Cellules
|
cells | array of ApiItemCell |
Liste de toutes les cellules de cette colonne. Le nombre doit toujours être égal au nombre de colonnes. |
ApiItemTable
Tableau des éléments
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
Index de la page à laquelle appartient la table. |
|
offset
|
offset | Offset |
Définit un décalage bidimensionnel avec des coordonnées X et Y. |
|
columns
|
columns | array of ApiItemColumn |
Liste des définitions de colonnes. |
|
Lignes
|
rows | array of ApiItemRow |
Liste des définitions de lignes et des cellules de chaque ligne. |
ApiPage
Page Document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
index
|
index | integer |
Index de page de document. Indexé à partir de 1. |
|
width
|
width | integer |
Largeur de la page en pixels. |
|
height
|
height | integer |
Hauteur de la page en pixels. |
|
rotation
|
rotation | double |
Rotation de la page en degrés. |
|
words
|
words | array of ApiWord |
Liste de tous les mots présents sur la page. |
|
itemTable
|
itemTable | ApiItemTable |
Tableau des éléments |
ApiPluginResult
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pluginName
|
pluginName | string |
Obtient ou définit le nom du script qui a validé ce document |
|
resultCode
|
resultCode | PostProcessResult |
Résultat post-traitement |
|
value
|
value | string |
Obtient ou définit la collection de messages localisés |
|
extraInformationRequired
|
extraInformationRequired | boolean |
Obtient ou définit si des informations supplémentaires sont nécessaires |
|
extraInformationMessage
|
extraInformationMessage | string |
Obtient ou définit le message de configuration requise pour les informations supplémentaires |
ApiUploadResponse
Résultat d’un chargement de fichier
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
Document Id |
|
folderId
|
folderId | string |
ID de dossier |
ApiUser
Informations utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
ID de l’utilisateur |
|
firstName
|
firstName | string |
Prénom de l’utilisateur |
|
lastName
|
lastName | string |
Nom de l’utilisateur |
|
Messagerie électronique
|
string |
E-mail de l’utilisateur |
ApiUserApiListResult
Résultat de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
list
|
list | array of ApiUser |
Liste de toutes les valeurs trouvées |
|
hasMore
|
hasMore | boolean |
True si la recherche peut retourner d’autres valeurs |
|
offset
|
offset | integer |
Valeur de décalage (nombre de valeurs ignorées) |
ApiWord
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
wordId
|
wordId | integer |
ID du mot, unique pour un document |
|
pageIndex
|
pageIndex | integer |
Index de la page que le mot est présenté |
|
texte
|
text | string |
Texte du mot |
|
locX
|
locX | integer |
Coordonnée X du mot |
|
locY
|
locY | integer |
Coordonnée Y du mot |
|
width
|
width | integer |
Largeur de Word |
|
height
|
height | integer |
Hauteur de Word |
ApprovalState
DocumentSource
DocumentState
LicenseTimePeriod
MLicense
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
responseCode
|
responseCode | ResponseCode | |
|
responseMessage
|
responseMessage | string | |
|
validFrom
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
nextPeriod
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usageLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
Période pour les licences |
|
isTrial
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
Décalage
Définit un décalage bidimensionnel avec des coordonnées X et Y.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
x
|
x | double |
Décalage à la coordonnée X. |
|
y
|
y | double |
Décalage à la coordonnée Y. |
PostProcessResult
RedQueStatus
Données de réponse d’état. Utilisé comme réponse lorsque la requête ne retourne aucune donnée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
statusCode
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
Code de Réponse
StringApiValue
Valeur de réponse générique
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | string |
Valeur |