GoFileRoom
GoFileRoom est une solution de gestion de documents et de flux de travail basée sur le cloud. Avec le connecteur GoFileRoom, vous pouvez effectuer des actions document, gestion des utilisateurs et FirmFlow.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Norme | 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 | Norme | 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 | Norme | 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 GoFileRoom |
| URL | https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact |
| Messagerie électronique | CS.Support@ThomsonReuters.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Thomson Reuters |
| Site internet | https://www.gofileroom.com/ |
| Politique de confidentialité | https://www.thomsonreuters.com/en/privacy-statement.html |
| Catégories | Données; Gestion de l’entreprise |
Le connecteur GoFileRoom offre aux clients Thomson Reuters un moyen simple d’utiliser les API pour GoFileRoom et FirmFlow. Les utilisateurs peuvent créer une automatisation et une intégration liées à la gestion des utilisateurs, aux documents ou à FirmFlow.
Prerequisites
Les utilisateurs doivent disposer d’une clé API GoFileRoom pour pouvoir utiliser le connecteur.
Comment obtenir des informations d’identification ?
La clé API peut être obtenue en vous inscrivant pour un compte à l’adresse https://developerportal.thomsonreuters.com/. En outre, vous devez disposer d’un compte GoFileRoom actif. Si vous êtes intéressé par GoFileRoom, contactez-nous ici : https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact
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 |
|---|---|---|---|
| X-TR-API -APP-ID | securestring | X-TR-API-APP-ID pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un livrable principal |
Ajouter un livrable principal |
| Connectez-vous |
Journalise un utilisateur dans l’application |
| Copier un document |
Copie les documents |
| Créer des utilisateurs |
Crée des utilisateurs GoFileRoom et ClientFlow dans le système |
| Créer un document |
Crée un enregistrement de document avec des index |
| Créer un flux de travail |
Créer un flux de travail |
| Créer un groupe |
Crée un groupe d’autorisations |
| Déconnexion |
Déconnexion de l’application |
| Définir des autorisations de groupe |
Affecte l’autorisation au groupe |
| Définir des autorisations utilisateur |
Affecte l’autorisation à l’utilisateur |
| Définir la sécurité des documents de groupe |
Affecte la sécurité des documents à un groupe |
| Définir la sécurité des documents utilisateur |
Affecte des autorisations de sécurité de document utilisateur |
| Fusionner les fichiers PDF |
Fusionner des fichiers PDF ensemble |
|
Index Lookup |
Cette méthode est conçue pour être utilisée avec les champs de saisie semi-automatique. |
| Modifier le groupe |
Modifier les autorisations de groupe |
| Modifier le livrable maître |
Modifier le livrable maître |
| Modifier l’utilisateur |
Modifier les autorisations utilisateur |
|
Modifier Work |
Modifier WorkFlow |
| Obtenir des autorisations de groupe |
Obtient les autorisations des groupes |
| Obtenir des autorisations utilisateur |
Obtient les autorisations de l’utilisateur |
|
Obtenir des données Firm |
Obtient les données du rapport de suivi par livrable |
| Obtenir des groupes |
Récupère les groupes disponibles pour la gestion des utilisateurs et des groupes |
| Obtenir des index de document |
Récupère les index du document |
| Obtenir des index de tiroir |
Récupère une liste d’index de document configurés pour le tiroir |
| Obtenir des index enfants |
Obtient une liste de valeurs d’index enfants en fonction de l’ID de liste, qui est fourni lorsque la valeur de liste parente est sélectionnée. |
| Obtenir des informations utilisateur |
Récupère les informations utilisateur du GFR |
| Obtenir des licences |
Récupère les nombres de licences |
| Obtenir des règles dynamiques pour l’index |
Obtient la liste des règles dynamiques configurées pour l’index spécifié |
| Obtenir des tiroirs |
Récupère les tiroirs accessibles pour l’utilisateur connecté |
| Obtenir des utilisateurs |
Récupère les utilisateurs GFR pour l’utilisateur connecté |
| Obtenir la liste des rapports |
Récupère les rapports disponibles pour la gestion des utilisateurs |
| Obtenir la liste des valeurs d’index |
Obtient toutes les entrées d’un index de type de liste |
| Obtenir la stratégie de mot de passe |
Récupère la stratégie de mot de passe pour l’entreprise |
| Obtenir la sécurité des documents de groupe |
Récupérer la sécurité des documents de groupe |
| Obtenir la sécurité des documents utilisateur |
Récupère la sécurité des documents utilisateur par connexion |
| Obtenir le livrable principal |
Obtenir le livrable principal |
| Obtenir les emplacements de chargement |
Récupère les emplacements de chargement pour l’utilisateur |
| Obtenir les informations utilisateur V2 |
Obtient l’infromation utilisateur |
|
Obtenir les valeurs Lookup |
Récupère les valeurs à partir de LookupList |
| Obtenir l’historique des documents |
Obtient l’historique du document |
| Obtenir l’état du document |
Obtenir l’état des documents |
| Obtenir un document |
Télécharge le document |
| Publier l’état du document |
Publier ou annuler la publication de documents à partir de ClientFlow. |
| Rapport de suivi par livrable V2 |
Rapport de suivi par livrableV2 |
| Recherche de documents |
Charge tous les documents auxquels l’utilisateur a accès dans le tiroir spécifié. |
| Routage du flux de travail V2 |
Routage du flux de travail V2 |
| Réindexation du document |
Réindexe les documents |
| Suivi du rapport par flux de travail |
Suivi du rapport par flux de travail |
| Supprimer des flux de travail |
Supprimer des flux de travail |
| Supprimer l'utilisateur |
Supprimer des utilisateurs GoFileRoom et ClientFlow du système |
| Supprimer le livrable principal |
Supprimer le livrable principal |
| Supprimer un document |
Supprime un document |
| Taxsort Document |
Document PDF Taxsort |
| Valider le jeton |
Valider l’état du jeton |
| Valider les index |
Vérifie si les index fournis sont valides. |
Ajouter un livrable principal
Ajouter un livrable principal
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Nom du livrable
|
deliverableName | string |
Nom du livrable |
|
|
Date d'échéance
|
dueDate | string |
Date d'échéance |
|
|
Première extension
|
firstExtension | string |
Première extension |
|
|
Deuxième extension
|
secondExtension | string |
Deuxième extension |
|
|
Troisième extension
|
thirdExtension | string |
Troisième extension |
|
|
Calendrier ou fiscal
|
calenderOrFiscal | string |
Calendrier ou fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
Nom du tiroir
|
DrawerName | string |
Nom du tiroir |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Est enregistré
|
isSaved | boolean |
Est enregistré |
|
Message de réponse
|
responseMessage | string |
Message de réponse |
Connectez-vous
Journalise un utilisateur dans l’application
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom d'utilisateur
|
LoginName | True | string |
Entrer le nom de connexion |
|
Mot de passe
|
Password | True | password |
Entrer le mot de passe |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
authSuccess
|
authSuccess | boolean |
a été l’authentification réussie |
|
authenticationResponse
|
authenticationResponse | string |
valeur de réponse d’authentification |
|
customerId
|
customerId | string |
Valeur de l’ID client |
|
code d'erreur
|
errorCode | string |
valeur du code d’erreur |
|
idleSessionTimeoutMinutes
|
idleSessionTimeoutMinutes | integer |
Minutes d’expiration du délai d’inactivité de session |
|
loneStarFirmId
|
loneStarFirmId | string |
lone Star Firm Id |
|
loneStarValidated
|
loneStarValidated | boolean |
Lone Star Validé |
|
token
|
token | string |
valeur du jeton |
|
userId
|
userId | string |
valeur de l’ID utilisateur |
|
nom d’utilisateur
|
userName | string |
valeur de nom d’utilisateur |
Copier un document
Copie les documents
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Entrer l’ID d’index |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
copyDocumentException
|
copyDocumentException | string |
Copier l’exception de document |
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
isCopied
|
isCopied | boolean |
Le document a-t-il été copié |
|
newDocumentId
|
newDocumentId | string |
nouvel ID de document |
Créer des utilisateurs
Crée des utilisateurs GoFileRoom et ClientFlow dans le système
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d'utilisateur
|
userType | string |
Entrer le type d’utilisateur |
|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Entrer la date d’expiration du compte |
|
|
DisabledComments
|
DisabledComments | string |
Entrer des commentaires désactivés |
|
|
FullName
|
FullName | string |
Nom complet de l’utilisateur |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpires
|
IsAccountExpires | string |
Spécifier true ou false |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Spécifier true ou false |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Spécifier true ou false |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Spécifier true ou false |
|
|
EstDésactivé
|
IsDisabled | string |
Spécifier true ou false |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Spécifier true ou false |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Spécifier true ou false |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Spécifier true ou false |
|
|
IsMfa
|
IsMfa | string |
Spécifier true ou false |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Spécifier true ou false |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Spécifier true ou false |
|
|
LicenseType
|
LicenseType | string |
Entrer le type de licence |
|
|
Nom d'utilisateur
|
LoginName | string |
Entrer le nom de connexion |
|
|
ManagerEmail
|
ManagerEmail | string |
Entrer un e-mail du gestionnaire |
|
|
Mot de passe
|
Password | string |
Entrer le mot de passe |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Spécifier true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Spécifier true ou false |
|
|
ReportType
|
ReportType | string |
Spécifier true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Entrer l’emplacement de chargement |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
createUserException
|
createUserException | string |
créer une exception utilisateur |
|
isCreated
|
isCreated | boolean |
L’utilisateur a-t-il été créé |
|
mfaException
|
mfaException | string |
exception mfa |
|
userId
|
userId | string |
valeur de l’ID utilisateur |
Créer un document
Crée un enregistrement de document avec des index
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
DrawerId
|
DrawerId | string |
Entrer l’ID du tiroir |
|
|
IndexId
|
IndexId | string |
Entrer l’ID d’index |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documentId
|
documentCreate.documentId | string |
Valeur d’ID de document |
|
errorMessage
|
documentCreate.errorMessage | string |
message d'erreur |
|
errorMessage
|
indexValidation.errorMessage | string |
message d'erreur |
|
Erreurs
|
indexValidation.errors | array of |
Erreurs |
|
isValid
|
indexValidation.isValid | boolean |
est valide pour le document |
Créer un flux de travail
Créer un flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Nom du tiroir
|
Drawer | string |
Nom du tiroir |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
ID de dossier
|
folderId | string |
ID de dossier |
|
|
Nom du client
|
ClientName | string |
Nom du client |
|
|
Numéro de client
|
ClientNumber | string |
Numéro de client |
|
|
Type d’engagement
|
EngagementType | string |
Type d’engagement |
|
|
PIC
|
PIC | string |
PIC |
|
|
Année
|
Year | string |
Année |
|
|
Fin de la période
|
PeriodEnd | string |
Fin de la période |
|
|
Nom du flux de travail
|
workflowName | string |
Nom du flux de travail |
|
|
Descriptif
|
description | True | string |
Descriptif |
|
Nom du statut
|
statusName | string |
Nom du statut |
|
|
Action de livrable
|
action | string |
Action de livrable |
|
|
Date d’échéance actuelle
|
currentduedate | string |
Date d’échéance actuelle |
|
|
Date d’échéance d’origine
|
originalduedate | string |
Date d’échéance d’origine |
|
|
Formulaire de livrable
|
form | string |
Formulaire de livrable |
|
|
Méthode de remise
|
Delivery | string |
Méthode de remise |
|
|
Destination
|
Destination | string |
Destination |
|
|
Source Document
|
sourceDocument | string |
Source Document |
|
|
Note Action
|
action | string |
Note Action |
|
|
Note Type
|
noteType | string |
Note Type |
|
|
Note Message
|
note | string |
Note Message |
|
|
Nom du champ d’informations
|
name | string |
Nom du champ d’informations |
|
|
Valeur du champ Information
|
value | string |
Valeur du champ Information |
|
|
Champ responsable
|
ResponsibleField | string |
Champ responsable |
|
|
Valeur du champ responsable
|
value | string |
Valeur du champ responsable |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de classement
|
filingId | integer |
ID de classement |
|
Commentaire d’erreur
|
errorComment | string |
Commentaire d’erreur |
|
Statut
|
status | boolean |
Statut |
|
errorMessage
|
errorMessage | array of string |
errorMessage |
Créer un groupe
Crée un groupe d’autorisations
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Spécifier true ou false |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Spécifier true ou false |
|
|
Commentaires
|
Comments | string |
Entrer des commentaires |
|
|
EnableMfa
|
EnableMfa | string |
Spécifier true ou false |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Spécifier true ou false |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Spécifier true ou false |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Spécifier true ou false |
|
|
GroupName
|
GroupName | string |
Entrer le nom du groupe |
|
|
MfaRequired
|
MfaRequired | string |
Spécifier true ou false |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Spécifier true ou false |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Spécifier true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Spécifier true ou false |
|
|
ReportType
|
ReportType | string |
Spécifier true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Entrer l’emplacement de chargement |
|
|
Users
|
Users | array of string |
Users |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
createGroupException
|
createGroupException | string |
créer une exception de groupe |
|
groupId
|
groupId | string |
valeur d’ID de groupe |
|
isCreated
|
isCreated | boolean |
Le groupe a-t-il été créé |
|
mfaException
|
mfaException | string |
état mfa |
Déconnexion
Déconnexion de l’application
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isLogoutSuccess
|
isLogoutSuccess | boolean |
La déconnexion a-t-elle réussi |
Définir des autorisations de groupe
Affecte l’autorisation au groupe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Cabinet
|
Cabinet | string |
Entrer le nom du cabinet |
|
|
Ajouter
|
Add | string |
Spécifier true ou false |
|
|
Supprimer
|
Delete | string |
Spécifier true ou false |
|
|
Deny
|
Deny | string |
Spécifier true ou false |
|
|
Edit
|
Edit | string |
Spécifier true ou false |
|
|
LookUp
|
LookUp | string |
Spécifier true ou false |
|
|
Lire
|
Read | string |
Spécifier true ou false |
|
|
Tiroir
|
Drawer | string |
Entrer le nom du tiroir |
|
|
Ajouter
|
Add | string |
Spécifier true ou false |
|
|
Supprimer
|
Delete | string |
Spécifier true ou false |
|
|
Deny
|
Deny | string |
Spécifier true ou false |
|
|
Edit
|
Edit | string |
Spécifier true ou false |
|
|
LookUp
|
LookUp | string |
Spécifier true ou false |
|
|
Lire
|
Read | string |
Spécifier true ou false |
|
|
GroupName
|
GroupName | string |
Entrer le nom du groupe |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valeur d’ID de groupe |
|
groupPermissionException
|
groupPermissionException | string |
exception d’autorisation de groupe |
|
isSet
|
isSet | boolean |
Autorisations appliquées |
Définir des autorisations utilisateur
Affecte l’autorisation à l’utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Cabinet
|
Cabinet | string |
Entrer le nom du cabinet |
|
|
Ajouter
|
Add | string |
Spécifier true ou false |
|
|
Supprimer
|
Delete | string |
Spécifier true ou false |
|
|
Deny
|
Deny | string |
Spécifier true ou false |
|
|
Edit
|
Edit | string |
Spécifier true ou false |
|
|
LookUp
|
LookUp | string |
Spécifier true ou false |
|
|
Lire
|
Read | string |
Spécifier true ou false |
|
|
Tiroir
|
Drawer | string |
Entrer le nom du tiroir |
|
|
Ajouter
|
Add | string |
Spécifier true ou false |
|
|
Supprimer
|
Delete | string |
Spécifier true ou false |
|
|
Deny
|
Deny | string |
Spécifier true ou false |
|
|
Edit
|
Edit | string |
Spécifier true ou false |
|
|
LookUp
|
LookUp | string |
Spécifier true ou false |
|
|
Lire
|
Read | string |
Spécifier true ou false |
|
|
LoginId
|
LoginId | string |
Entrer l’ID de connexion |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isSetUserPermission
|
isSetUserPermission | boolean |
Mise à jour des autorisations utilisateur |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
|
setUserPermissionException
|
setUserPermissionException | string |
définir l’exception d’autorisation utilisateur |
Définir la sécurité des documents de groupe
Affecte la sécurité des documents à un groupe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
CabinetName
|
CabinetName | string |
Entrez le nom du cabinet |
|
|
DocSecurityType
|
DocSecurityType | string |
Entrer le type de sécurité de document |
|
|
IndexName
|
IndexName | string |
Entrez le nom de l’index |
|
|
Opération
|
Operation | string |
Entrer le type d’opération |
|
|
Valeurs
|
Values | array of string |
Valeurs |
|
|
DrawerName
|
DrawerName | string |
Entrez le nom du tiroir |
|
|
GroupName
|
GroupName | string |
Entrez le nom du groupe |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
groupName
|
groupName | string |
Valeur nom du groupe |
|
isSetGroupDocSecurity
|
isSetGroupDocSecurity | boolean |
Document Security a-t-il été défini |
|
setGroupDocSecurityException
|
setGroupDocSecurityException | string |
Exception de sécurité de document de groupe |
Définir la sécurité des documents utilisateur
Affecte des autorisations de sécurité de document utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
CabinetName
|
CabinetName | string |
Entrer le nom du cabinet |
|
|
DocSecurityType
|
DocSecurityType | string |
Entrer le type de sécurité de document |
|
|
IndexName
|
IndexName | string |
Entrer le nom de l’index |
|
|
Opération
|
Operation | string |
Entrée de l’opération |
|
|
Valeurs
|
Values | array of string |
Valeurs |
|
|
DrawerName
|
DrawerName | string |
Entrer le nom du tiroir |
|
|
LoginId
|
LoginId | string |
Entrer l’ID de connexion |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isSetUserDocSecurity
|
isSetUserDocSecurity | boolean |
La sécurité des documents utilisateur a-t-elle été appliquée |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
|
setUserDocSecurityException
|
setUserDocSecurityException | string |
définir l’exception de sécurité de la documentation utilisateur |
Fusionner les fichiers PDF
Fusionner des fichiers PDF ensemble
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
body
|
body | array of string |
Retours
- response
- string
Index LookupList Find
Cette méthode est conçue pour être utilisée avec les champs de saisie semi-automatique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
IndexID
|
indexId | True | string |
Entrer l’ID d’index |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Type d'action
|
ActionType | integer |
Entrer le type d’action |
|
|
Nombre
|
Count | integer |
Entrer le nombre |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
|
|
Type de recherche
|
SearchType | integer |
Entrer le type de recherche |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
index.indexId | string |
valeur d’ID d’index |
|
indexValue
|
index.indexValue | string |
valeur d’index |
|
linkedIndexes
|
linkedIndexes | array of object |
linkedIndexes |
|
indexId
|
linkedIndexes.indexId | string |
indexId |
|
indexValue
|
linkedIndexes.indexValue | string |
indexValue |
Modifier le groupe
Modifier les autorisations de groupe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Spécifier true ou false |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Spécifier true ou false |
|
|
Commentaires
|
Comments | string |
Entrer des commentaires |
|
|
EnableMfa
|
EnableMfa | string |
Spécifier true ou false |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Spécifier true ou false |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Spécifier true ou false |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Spécifier true ou false |
|
|
GroupName
|
GroupName | string |
Entrer le nom du groupe |
|
|
MfaRequired
|
MfaRequired | string |
Spécifier true ou false |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Spécifier true ou false |
|
|
RenameGroup
|
RenameGroup | string |
Entrer un nouveau nom de groupe |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Spécifier true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Spécifier true ou false |
|
|
ReportType
|
ReportType | string |
Spécifier true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Entrer l’emplacement de chargement |
|
|
Users
|
Users | array of string |
Users |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valeur d’ID de groupe |
|
isModified
|
isModified | boolean |
Le groupe a-t-il été modifié |
|
mfaException
|
mfaException | string |
exception mfa |
|
modifyGroupException
|
modifyGroupException | string |
modifier l’exception de groupe |
Modifier le livrable maître
Modifier le livrable maître
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Nom du livrable actuel
|
currentdeliverableName | string |
Nom du livrable actuel |
|
|
Mettre à jour le nom du livrable
|
updatedeliverableName | string |
Mettre à jour le nom du livrable |
|
|
Date d'échéance
|
dueDate | string |
Date d'échéance |
|
|
Première extension
|
firstExtension | string |
Première extension |
|
|
Deuxième extension
|
secondExtension | string |
Deuxième extension |
|
|
Troisième extension
|
thirdExtension | string |
Troisième extension |
|
|
Calendrier ou fiscal
|
calenderOrFiscal | string |
Calendrier ou fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Service Type
|
serviceType | string |
Service Type |
|
|
Nom du tiroir
|
drawerName | string |
Nom du tiroir |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut de la mise à jour
|
isUpdated | boolean |
Statut de la mise à jour |
|
Message de réponse
|
responseMessage | string |
Message de réponse |
Modifier l’utilisateur
Modifier les autorisations utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d'utilisateur
|
userType | string |
Entrer le type d’utilisateur |
|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Date d’expiration du compte |
|
|
DisabledComments
|
DisabledComments | string |
Entrer des commentaires |
|
|
FullName
|
FullName | string |
Entrer le nom complet |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpires
|
IsAccountExpires | string |
Spécifier true ou false |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Spécifier true ou false |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Spécifier true ou false |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Spécifier true ou false |
|
|
IsChangeNextLogin
|
IsChangeNextLogin | string |
Spécifier true ou false |
|
|
EstDésactivé
|
IsDisabled | string |
Spécifier true ou false |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Spécifier true ou false |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Spécifier true ou false |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Spécifier true ou false |
|
|
IsMfa
|
IsMfa | string |
Spécifier true ou false |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Spécifier true ou false |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Spécifier true ou false |
|
|
LicenseType
|
LicenseType | string |
Entrer le type de licence |
|
|
Nom d'utilisateur
|
LoginName | string |
Entrer le nom de connexion |
|
|
ManagerEmail
|
ManagerEmail | string |
Entrer un e-mail du gestionnaire |
|
|
Mot de passe
|
Password | string |
Entrer le mot de passe |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Spécifier true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Spécifier true ou false |
|
|
ReportType
|
ReportType | string |
Spécifier true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Entrer l’emplacement de chargement |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isModified
|
isModified | boolean |
L’utilisateur a-t-il été modifié |
|
mfaException
|
mfaException | string |
exception mfa |
|
modifyUserException
|
modifyUserException | string |
modifier l’exception utilisateur |
|
userId
|
userId | string |
valeur de l’ID utilisateur |
Modifier WorkFlow
Modifier WorkFlow
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
ID de classement
|
filingId | integer |
ID de classement |
|
|
Nom du client
|
ClientName | string |
Nom du client |
|
|
Numéro de client
|
ClientNumber | string |
Numéro de client |
|
|
Type d’engagement
|
EngagementType | string |
Type d’engagement |
|
|
PIC
|
PIC | string |
PIC |
|
|
Année
|
Year | string |
Année |
|
|
Fin de la période
|
PeriodEnd | string |
Fin de la période |
|
|
Nom du livrable
|
action | string |
Nom du livrable |
|
|
Date d’échéance actuelle
|
currentduedate | string |
Date d’échéance actuelle |
|
|
Date d’échéance d’origine
|
originalduedate | string |
Date d’échéance d’origine |
|
|
Attachment
|
form | string |
Attachment |
|
|
Note Action
|
action | string |
Note Action |
|
|
Note Type
|
noteType | string |
Note Type |
|
|
noteid
|
noteid | array of string |
noteid |
|
|
Note Message
|
note | string |
Note Message |
|
|
Nom du champ d’informations
|
name | string |
Nom du champ d’informations |
|
|
Valeur du champ Information
|
value | string |
Valeur du champ Information |
|
|
Méthode de remise
|
Delivery | string |
Méthode de remise |
|
|
Destination
|
Destination | string |
Destination |
|
|
Source Document
|
sourceDocument | string |
Source Document |
|
|
Champ responsable
|
responsibleField | string |
Champ responsable |
|
|
Affectation
|
value | string |
Affectation |
|
|
Réindexer docs
|
reindexDocs | boolean |
Réindexer docs |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de classement
|
filingId | integer |
ID de classement |
|
Commentaire d’erreur
|
errorComment | string |
Commentaire d’erreur |
|
Statut
|
status | boolean |
Statut |
|
errorMessage
|
errorMessage | array of object |
errorMessage |
|
Nom
|
errorMessage.name | string |
Nom |
|
Statut
|
errorMessage.status | boolean |
Statut |
|
Commentaire d’erreur
|
errorMessage.errorComment | string |
Commentaire d’erreur |
Obtenir des autorisations de groupe
Obtient les autorisations des groupes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
GroupName
|
groupName | string |
Entrer le nom du groupe |
|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
Nom du cabinet |
|
ajouter
|
cabinetPermissions.add | boolean |
ajouter des autorisations |
|
delete
|
cabinetPermissions.delete | boolean |
supprimer des autorisations |
|
deny
|
cabinetPermissions.deny | boolean |
refuser les autorisations |
|
edit
|
cabinetPermissions.edit | boolean |
modifier les autorisations |
|
Recherche
|
cabinetPermissions.lookUp | boolean |
Autorisations de recherche |
|
read
|
cabinetPermissions.read | boolean |
autorisations de lecture |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
tiroir
|
drawerPermissions.drawer | string |
Nom du tiroir |
|
ajouter
|
drawerPermissions.permission.add | boolean |
ajouter des autorisations |
|
delete
|
drawerPermissions.permission.delete | boolean |
supprimer des autorisations |
|
deny
|
drawerPermissions.permission.deny | boolean |
refuser les autorisations |
|
edit
|
drawerPermissions.permission.edit | boolean |
modifier les autorisations |
|
Recherche
|
drawerPermissions.permission.lookUp | boolean |
Autorisations de recherche |
|
read
|
drawerPermissions.permission.read | boolean |
autorisations de lecture |
|
groupName
|
groupName | string |
Nom du groupe |
|
groupPermissionException
|
groupPermissionException | string |
Exception d’autorisation de groupe |
Obtenir des autorisations utilisateur
Obtient les autorisations de l’utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Connectez-vous
|
login | True | string |
Entrer la connexion |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
valeur du nom du cabinet |
|
ajouter
|
cabinetPermission.add | boolean |
ajouter une valeur |
|
delete
|
cabinetPermission.delete | boolean |
supprimer la valeur |
|
deny
|
cabinetPermission.deny | boolean |
refuser la valeur |
|
edit
|
cabinetPermission.edit | boolean |
modifier la valeur |
|
Recherche
|
cabinetPermission.lookUp | boolean |
Valeur de recherche |
|
read
|
cabinetPermission.read | boolean |
valeur de lecture |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
tiroir
|
drawerPermissions.drawer | string |
valeur du nom du tiroir |
|
ajouter
|
drawerPermissions.permission.add | boolean |
ajouter une valeur |
|
delete
|
drawerPermissions.permission.delete | boolean |
supprimer la valeur |
|
deny
|
drawerPermissions.permission.deny | boolean |
refuser la valeur |
|
edit
|
drawerPermissions.permission.edit | boolean |
modifier la valeur |
|
Recherche
|
drawerPermissions.permission.lookUp | boolean |
Valeur de recherche |
|
read
|
drawerPermissions.permission.read | boolean |
valeur de lecture |
|
getUserPermissionException
|
getUserPermissionException | string |
Exception d’autorisation utilisateur |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
Obtenir des données FirmFlow par livrable
Obtient les données du rapport de suivi par livrable
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Responsable
|
Accountable | string |
Entrer une valeur accountable |
|
|
AssignedOn
|
AssignedOn | string |
Entrer affecté à la date |
|
|
AssignedTo
|
AssignedTo | string |
Entrer affecté à la valeur |
|
|
AssignmentHistory
|
AssignmentHistory | string |
Entrer l’historique des affectations |
|
|
CompletedBy
|
CompletedBy | string |
Entrez Terminé par valeur |
|
|
CompletedOn
|
CompletedOn | string |
Entrer terminé à la date |
|
|
CurrentDueDate
|
CurrentDueDate | string |
Entrer la date d’échéance actuelle |
|
|
CurrentStep
|
CurrentStep | string |
Entrer l’étape actuelle |
|
|
DateExtended
|
DateExtended | string |
Entrer la date étendue |
|
|
DaysAtStep
|
DaysAtStep | string |
Entrer des jours à l’étape |
|
|
DaysBetweenRoutings
|
DaysBetweenRoutings | string |
Entrer des jours entre les routages |
|
|
DrawerId
|
DrawerId | string |
Entrer l’ID du tiroir |
|
|
EngagementType
|
EngagementType | string |
Entrer le type d’engagement |
|
|
InProcessOnly
|
InProcessOnly | string |
Entrer dans la valeur Process Uniquement |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Champs d’informations
|
InformationFields | array of string |
Champs d’informations |
|
|
OriginalDueDate
|
OriginalDueDate | string |
Entrer la date d’échéance d’origine |
|
|
PIC
|
PIC | string |
Entrer PIC |
|
|
Numéro de page
|
PageNumber | string |
Entrer le numéro de page |
|
|
Priority
|
Priority | string |
Entrer la priorité |
|
|
ReceivedFrom
|
ReceivedFrom | string |
Entrée reçue à partir de la valeur |
|
|
ReceivedOn
|
ReceivedOn | string |
Entrer reçu à la date |
|
|
Responsable
|
Responsible | string |
Entrer la valeur responsable |
|
|
RoutingDetails
|
RoutingDetails | string |
Entrer les détails du routage |
|
|
SentOn
|
SentOn | string |
Entrer envoyé à la date |
|
|
SentTo
|
SentTo | string |
Entrer la valeur Envoyée à |
|
|
ServiceType
|
ServiceType | string |
Entrer le type de service |
|
|
Statut
|
Status | string |
Entrer l’état |
|
|
TotalDaysAtStep
|
TotalDaysAtStep | string |
Entrer le nombre total de jours à l’étape |
|
|
TotalDaysInProcess
|
TotalDaysInProcess | string |
Entrer le nombre total de jours dans le processus |
|
|
Flux de travail
|
Workflow | string |
Entrer le nom du flux de travail |
|
|
WorkflowDescription
|
WorkflowDescription | string |
Entrer la description du flux de travail |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
responsable
|
firmFlowReportResponse.accountable | string |
valeur responsable |
|
assignedOn
|
firmFlowReportResponse.assignedOn | string |
affecté à la date |
|
assignedTo
|
firmFlowReportResponse.assignedTo | string |
affecté à la valeur |
|
assignedToYesOrNo
|
firmFlowReportResponse.assignedToYesOrNo | string |
Le flux de travail est-il affecté |
|
assignmentHistory
|
firmFlowReportResponse.assignmentHistory | string |
Valeur de l’historique des affectations |
|
clientName
|
firmFlowReportResponse.clientName | string |
valeur du nom du client |
|
clientNumber
|
firmFlowReportResponse.clientNumber | string |
valeur numéro du client |
|
completedBy
|
firmFlowReportResponse.completedBy | string |
terminé par valeur |
|
completedOn
|
firmFlowReportResponse.completedOn | string |
terminé à la date |
|
currentDueDate
|
firmFlowReportResponse.currentDueDate | string |
date d’échéance actuelle |
|
currentStep
|
firmFlowReportResponse.currentStep | string |
Valeur de l’étape actuelle |
|
dateExtended
|
firmFlowReportResponse.dateExtended | string |
date étendue |
|
daysAtStep
|
firmFlowReportResponse.daysAtStep | string |
jours de flux de travail à l’étape |
|
daysBetweenRoutings
|
firmFlowReportResponse.daysBetweenRoutings | string |
jours de flux de travail entre les routages |
|
Livrables
|
firmFlowReportResponse.deliverables | string |
valeur des livrables |
|
drawerId
|
firmFlowReportResponse.drawerId | string |
Valeur d’ID du tiroir |
|
eFileYesOrNo
|
firmFlowReportResponse.eFileYesOrNo | string |
est le livrable à envoyer par eFiled |
|
engagementType
|
firmFlowReportResponse.engagementType | string |
valeur de type d’engagement |
|
extendedYesOrNo
|
firmFlowReportResponse.extendedYesOrNo | string |
a été étendu au livrable |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nom
|
firmFlowReportResponse.informationFields.name | string |
nom |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
originalDueDate
|
firmFlowReportResponse.originalDueDate | string |
date d’échéance d’origine |
|
periodEnd
|
firmFlowReportResponse.periodEnd | string |
fin du flux de travail |
|
Pic
|
firmFlowReportResponse.pic | string |
image du flux de travail |
|
picYesOrNo
|
firmFlowReportResponse.picYesOrNo | string |
l’image a été affectée |
|
priority
|
firmFlowReportResponse.priority | string |
valeur de priorité |
|
progrès
|
firmFlowReportResponse.progress | string |
valeur de progression |
|
receivedFrom
|
firmFlowReportResponse.receivedFrom | string |
reçu de la valeur |
|
receivedOn
|
firmFlowReportResponse.receivedOn | string |
reçu à la date |
|
responsable
|
firmFlowReportResponse.responsible | string |
valeur responsable |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
routingNotes
|
firmFlowReportResponse.routingNotes | string |
Notes de routage du flux de travail |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
sentOn
|
firmFlowReportResponse.sentOn | string |
envoyé à la date |
|
sentTo
|
firmFlowReportResponse.sentTo | string |
envoyé à la valeur |
|
serviceType
|
firmFlowReportResponse.serviceType | string |
type de service de flux de travail |
|
status
|
firmFlowReportResponse.status | string |
état du flux de travail |
|
totalDaysAtStep
|
firmFlowReportResponse.totalDaysAtStep | string |
nombre total de jours au niveau du flux de travail à l’étape |
|
totalDaysInProcess
|
firmFlowReportResponse.totalDaysInProcess | string |
nombre total de jours dans le processus de flux de travail |
|
flux de travail
|
firmFlowReportResponse.workflow | string |
type de flux de travail |
|
workflowDescription
|
firmFlowReportResponse.workflowDescription | string |
Description du flux de travail |
|
année
|
firmFlowReportResponse.year | string |
année de flux de travail |
|
getFirmFlowException
|
getFirmFlowException | string |
obtenir une exception FirmFlow |
|
pageNumber
|
pageNumber | string |
page Nombre de demandes |
|
pageSize
|
pageSize | integer |
taille de page de la requête |
|
totalPages
|
totalPages | integer |
nombre total de pages de requête |
|
totalRecords
|
totalRecords | integer |
nombre total d’enregistrements de requête |
Obtenir des groupes
Récupère les groupes disponibles pour la gestion des utilisateurs et des groupes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string |
Valeur d’ID de groupe |
|
Amf
|
mfa | integer |
valeur mfa |
|
mfaRequired
|
mfaRequired | integer |
valeur mfa Obligatoire |
|
nom
|
name | string |
Valeur du nom du groupe |
Obtenir des index de document
Récupère les index du document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Entrer l’ID du document |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
indexId | string |
valeur d’ID d’index |
|
indexValue
|
indexValue | string |
valeur d’index |
Obtenir des index de tiroir
Récupère une liste d’index de document configurés pour le tiroir
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DrawerId
|
drawerId | True | string |
Entrer l’ID du tiroir |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valeur d’ID d’index enfant |
|
indexId
|
indexId | string |
valeur d’ID d’index |
|
indexName
|
indexName | string |
valeur de nom d’index |
|
indexType
|
indexType | string |
valeur de type d’index |
|
length
|
length | integer |
Longueur de l’index du tiroir |
|
listId
|
listId | integer |
valeur d’ID de liste |
|
lookupAutoUpdate
|
lookupAutoUpdate | boolean |
Mise à jour automatique de recherche |
|
obligatoire
|
required | boolean |
Index requis |
Obtenir des index enfants
Obtient une liste de valeurs d’index enfants en fonction de l’ID de liste, qui est fourni lorsque la valeur de liste parente est sélectionnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Entrer l’ID d’index |
|
ListId
|
listId | True | string |
Entrer l’ID de liste |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valeur d’ID d’index enfant |
|
childListId
|
childListId | integer |
valeur d’ID de liste enfant |
|
hasChildren
|
hasChildren | boolean |
L’index a-t-il un index enfant |
|
listEntryId
|
listEntryId | integer |
valeur id d’entrée de liste |
|
listId
|
listId | integer |
valeur d’ID de liste |
|
value
|
value | string |
value |
Obtenir des informations utilisateur
Récupère les informations utilisateur du GFR
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Nom d'utilisateur
|
LoginName | True | string |
Entrez LoginName |
|
Type d'utilisateur
|
UserType | True | string |
Sélectionner UserType |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
createDate
|
createDate | string |
createDate |
|
createdBy
|
createdBy | string |
createdBy |
|
descriptif
|
description | string |
descriptif |
|
handicapé
|
disabled | integer |
handicapé |
|
disabledByAdmin
|
disabledByAdmin | boolean |
disabledByAdmin |
|
emailNotify
|
emailNotify | boolean |
emailNotify |
|
emailNotifyEventMgmtGroups
|
emailNotifyEventMgmtGroups | boolean |
emailNotifyEventMgmtGroups |
|
emailNotifyEventMgmtUsers
|
emailNotifyEventMgmtUsers | boolean |
emailNotifyEventMgmtUsers |
|
emailNotifyGroup
|
emailNotifyGroup | boolean |
emailNotifyGroup |
|
forcePasswordChange
|
forcePasswordChange | boolean |
forcePasswordChange |
|
fullName
|
fullName | string |
fullName |
|
hasDrawerSetupRights
|
hasDrawerSetupRights | string |
hasDrawerSetupRights |
|
isAdmin
|
isAdmin | integer |
isAdmin |
|
isManager
|
isManager | integer |
isManager |
|
licenseType
|
licenseType | string |
licenseType |
|
locationID
|
locationID | string |
locationID |
|
loginID
|
loginID | string |
loginID |
|
managerFullName
|
managerFullName | string |
managerFullName |
|
managerId
|
managerId | string |
managerId |
|
managerLoginId
|
managerLoginId | string |
managerLoginId |
|
oberonUser
|
oberonUser | integer |
oberonUser |
|
offline
|
offline | boolean |
offline |
|
passwordChangeDate
|
passwordChangeDate | string |
passwordChangeDate |
|
passwordChangeInterval
|
passwordChangeInterval | integer |
passwordChangeInterval |
|
passwordExpireDate
|
passwordExpireDate | string |
passwordExpireDate |
|
reports
|
reports | boolean |
reports |
|
signature
|
signature | string |
signature |
|
systemAdmin
|
systemAdmin | boolean |
systemAdmin |
|
taxFlow
|
taxFlow | boolean |
taxFlow |
|
userAdministration
|
userAdministration | integer |
userAdministration |
|
userID
|
userID | string |
userID |
|
workflowManagerUser
|
workflowManagerUser | boolean |
workflowManagerUser |
Obtenir des licences
Récupère les nombres de licences
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
LicenseType
|
license | string |
Entrer le type de licence |
|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
assignedLicenses
|
assignedLicenses | string |
nombre de licences attribuées |
|
getLicenseException
|
getLicenseException | string |
obtenir une exception de licence |
|
license
|
license | string |
nom de la licence |
|
Message
|
message | string |
Message |
|
totalLicenses
|
totalLicenses | string |
nombre total de licences |
Obtenir des règles dynamiques pour l’index
Obtient la liste des règles dynamiques configurées pour l’index spécifié
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Entrer l’ID d’index |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
condition
|
condition | string |
valeur de condition |
|
dependentIndexId
|
dependentIndexId | string |
valeur d’ID d’index dépendant |
|
dynamicRuleId
|
dynamicRuleId | string |
valeur d’ID de règle dynamique |
|
value
|
value | string |
value |
Obtenir des tiroirs
Récupère les tiroirs accessibles pour l’utilisateur connecté
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
drawerID
|
drawerID | string |
Valeur de l’ID du tiroir |
|
drawerName
|
drawerName | string |
valeur name du tiroir |
|
ajouter
|
permissions.add | boolean |
ajouter une valeur |
|
delete
|
permissions.delete | boolean |
supprimer la valeur |
|
edit
|
permissions.edit | boolean |
modifier la valeur |
|
lookupManagement
|
permissions.lookupManagement | boolean |
Valeur lookupManagement |
|
view
|
permissions.view | boolean |
valeur d’affichage |
Obtenir des utilisateurs
Récupère les utilisateurs GFR pour l’utilisateur connecté
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d'utilisateur
|
userType | string |
Entrer le type d’utilisateur |
|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
isActive
|
isActive | boolean |
Est-ce que l’utilisateur est actif |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
Obtenir la liste des rapports
Récupère les rapports disponibles pour la gestion des utilisateurs
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
reports
|
reports | array of object |
reports |
|
reportName
|
reports.reportName | array of string |
reportName |
|
Type de rapport
|
reports.reportType | string |
valeur de type de rapport |
|
reportsException
|
reportsException | string |
signale la valeur d’exception |
Obtenir la liste des valeurs d’index
Obtient toutes les entrées d’un index de type de liste
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Entrer l’ID d’index |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valeur d’ID d’index enfant |
|
childListId
|
childListId | integer |
valeur d’ID de liste enfant |
|
hasChildren
|
hasChildren | boolean |
L’index a-t-il un index enfant |
|
listEntryId
|
listEntryId | integer |
valeur id d’entrée de liste |
|
listId
|
listId | integer |
valeur d’ID de liste |
|
value
|
value | string |
value |
Obtenir la stratégie de mot de passe
Récupère la stratégie de mot de passe pour l’entreprise
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
clientId
|
passwordPolicy.clientId | string |
valeur d’ID client |
|
forbidden_pwd_words
|
passwordPolicy.forbidden_pwd_words | array of string |
forbidden_pwd_words |
|
lockout_threshold
|
passwordPolicy.lockout_threshold | integer |
seuil de verrouillage |
|
max_length
|
passwordPolicy.max_length | integer |
longueur maximale du mot de passe |
|
max_login_similarity
|
passwordPolicy.max_login_similarity | string |
similarité maximale de connexion |
|
max_pwd_age
|
passwordPolicy.max_pwd_age | integer |
âge maximal de pwd du mot de passe |
|
max_repeat_chars
|
passwordPolicy.max_repeat_chars | string |
nombre maximal de caractères répétés dans le mot de passe |
|
max_sequential_chars
|
passwordPolicy.max_sequential_chars | string |
nombre maximal de caractères séquentiels |
|
Amf
|
passwordPolicy.mfa | integer |
valeur mfa |
|
min_length
|
passwordPolicy.min_length | integer |
durée minimale du mot de passe |
|
pwd_req_alpha
|
passwordPolicy.pwd_req_alpha | integer |
Condition requise pour le mot de passe alpha |
|
pwd_req_lower
|
passwordPolicy.pwd_req_lower | integer |
Exigence de mot de passe inférieure |
|
pwd_req_number
|
passwordPolicy.pwd_req_number | integer |
Condition requise pour le numéro de mot de passe |
|
pwd_req_symbol
|
passwordPolicy.pwd_req_symbol | integer |
Condition requise pour le mot de passe de symbole |
|
pwd_req_upper
|
passwordPolicy.pwd_req_upper | integer |
Condition supérieure du mot de passe |
|
passwordPolicyException
|
passwordPolicyException | string |
passwordPolicyException |
Obtenir la sécurité des documents de groupe
Récupérer la sécurité des documents de groupe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
GroupName
|
groupName | True | string |
Entrer le nom du groupe |
|
CabinetName
|
cabinetName | True | string |
Entrer le nom du cabinet |
|
DrawerName
|
drawerName | True | string |
Entrer le nom du tiroir |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du groupe
|
groupName | string |
Nom du groupe |
|
Nom du cabinet
|
cabinetName | string |
Nom du cabinet |
|
Nom du tiroir
|
drawerName | string |
Nom du tiroir |
|
documentSecurity
|
documentSecurity | array of object |
documentSecurity |
|
Nom de l’index
|
documentSecurity.indexName | string |
Nom de l’index |
|
Type de sécurité Doc
|
documentSecurity.docSecurityType | string |
Type de sécurité Doc |
|
values
|
documentSecurity.values | array of string |
values |
|
Exception de sécurité de document de groupe
|
getGroupDocSecurityException | string |
Exception de sécurité de document de groupe |
Obtenir la sécurité des documents utilisateur
Récupère la sécurité des documents utilisateur par connexion
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
LoginId
|
loginId | True | string |
Entrer l’ID de connexion |
|
CabinetName
|
cabinetName | True | string |
Entrer le nom du cabinet |
|
DrawerName
|
drawerName | True | string |
Entrer le nom du tiroir |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
cabinetName
|
cabinetName | string |
nom du cabinet |
|
documentSecurity
|
documentSecurity | string |
valeur de sécurité du document |
|
drawerName
|
drawerName | string |
valeur du nom du tiroir |
|
getUserDocSecurityException
|
getUserDocSecurityException | string |
Exception de sécurité des documents utilisateur |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
Obtenir le livrable principal
Obtenir le livrable principal
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Numéro de page
|
PageNumber | integer |
Numéro de page |
|
|
Taille de page
|
pageSize | integer |
Taille de page |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
Nom du tiroir
|
DrawerName | string |
Nom du tiroir |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
livrableList
|
deliverableList | array of object |
livrableList |
|
Nom du livrable
|
deliverableList.deliverableName | string |
Nom du livrable |
|
Type d’extension
|
deliverableList.extensionType | string |
Type d’extension |
|
Date d'échéance
|
deliverableList.dueDate | string |
Date d'échéance |
|
Première extension
|
deliverableList.firstExtension | string |
Première extension |
|
Deuxième extension
|
deliverableList.secondExtension | string |
Deuxième extension |
|
Troisième extension
|
deliverableList.thirdExtension | string |
Troisième extension |
|
Extension
|
deliverableList.extension | string |
Extension |
|
Action
|
deliverableList.action | string |
Action |
|
ID d’obligation
|
deliverableList.obligationId | string |
ID d’obligation |
|
Option gérée par l’entreprise
|
deliverableList.firmManagedOption | string |
Option gérée par l’entreprise |
|
Nombre total d’enregistrements
|
totalRecords | string |
Nombre total d’enregistrements |
|
Message de réponse
|
responseMessage | string |
Message de réponse |
Obtenir les emplacements de chargement
Récupère les emplacements de chargement pour l’utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
uploadLocations
|
uploadLocations | array of object |
uploadLocations |
|
locationName
|
uploadLocations.locationName | string |
valeur nom de l’emplacement |
|
locationPath
|
uploadLocations.locationPath | string |
valeur de chemin d’accès d’emplacement |
|
uploadLocationsException
|
uploadLocationsException | string |
Charger l’exception locations |
Obtenir les informations utilisateur V2
Obtient l’infromation utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Nom de connexion
|
LoginName | string |
Nom de connexion |
|
|
Type d’utilisateur
|
UserType | string |
Type d’utilisateur |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
userID | string |
ID d’utilisateur |
|
ID de connexion
|
loginID | string |
ID de connexion |
|
Nom complet
|
fullName | string |
Nom complet |
|
Créer une date
|
createDate | string |
Créer une date |
|
Créée par
|
createdBy | string |
Créée par |
|
Descriptif
|
description | string |
Descriptif |
|
Disabled
|
disabled | integer |
Disabled |
|
Désactivé par l’administrateur
|
disabledByAdmin | boolean |
Désactivé par l’administrateur |
|
Date d’expiration du mot de passe
|
passwordExpireDate | string |
Date d’expiration du mot de passe |
|
Forcer la modification du mot de passe
|
forcePasswordChange | boolean |
Forcer la modification du mot de passe |
|
Date de modification du mot de passe
|
passwordChangeDate | string |
Date de modification du mot de passe |
|
Intervalle de modification du mot de passe
|
passwordChangeInterval | integer |
Intervalle de modification du mot de passe |
|
Type de licence
|
licenseType | string |
Type de licence |
|
Déconnecté(e)
|
offline | boolean |
Déconnecté(e) |
|
Rapports
|
reports | boolean |
Rapports |
|
Administrateur système
|
systemAdmin | boolean |
Administrateur système |
|
Signature
|
signature | string |
Signature |
|
ID d’emplacement
|
locationID | string |
ID d’emplacement |
|
Dispose des droits d’installation du tiroir
|
hasDrawerSetupRights | string |
Dispose des droits d’installation du tiroir |
|
Flux fiscal
|
taxFlow | boolean |
Flux fiscal |
|
Notification par e-mail
|
emailNotify | boolean |
Notification par e-mail |
|
Groupe d’notifications par e-mail
|
emailNotifyGroup | boolean |
Groupe d’notifications par e-mail |
|
E-mail Notifier les utilisateurs mgmt de l’événement
|
emailNotifyEventMgmtUsers | boolean |
E-mail Notifier les utilisateurs mgmt de l’événement |
|
Notifications par e-mail des groupes Mgmt d’événements
|
emailNotifyEventMgmtGroups | boolean |
Notifications par e-mail des groupes Mgmt d’événements |
|
Administration des utilisateurs du portail
|
portalUserAdministration | boolean |
Administration des utilisateurs du portail |
|
Administration interne des utilisateurs
|
internalUserAdministration | boolean |
Administration interne des utilisateurs |
|
Utilisateur du Gestionnaire de flux de travail
|
workflowManagerUser | boolean |
Utilisateur du Gestionnaire de flux de travail |
|
ID du gestionnaire
|
managerId | string |
ID du gestionnaire |
|
ID de connexion du gestionnaire
|
managerLoginId | string |
ID de connexion du gestionnaire |
|
Nom complet du gestionnaire
|
managerFullName | string |
Nom complet du gestionnaire |
|
Is Manager
|
isManager | integer |
Is Manager |
|
Utilisateur Oberon
|
oberonUser | integer |
Utilisateur Oberon |
|
Est administrateur
|
isAdmin | integer |
Est administrateur |
|
Dernière connexion
|
lastLogin | string |
Dernière connexion |
|
groups
|
groups | array of string |
groups |
Obtenir les valeurs LookupList
Récupère les valeurs à partir de LookupList
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du tiroir. Exemple de tiroir clients : « 0000000001 »
|
drawerId | True | string |
Entrer l’ID du tiroir |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
clientName
|
clientName | string |
valeur du nom du client |
|
clientNumber
|
clientNumber | string |
valeur du numéro de client |
Obtenir l’historique des documents
Obtient l’historique du document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Entrer l’ID du document |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documentAudit
|
documentAudit | array of |
documentAudit |
|
documentHistoryException
|
documentHistoryException | string |
Exception d’historique des documents |
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
mergeDocHistory
|
mergeDocHistory | array of |
mergeDocHistory |
Obtenir l’état du document
Obtenir l’état des documents
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
body
|
body | array of string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
documentStatusException
|
documentStatusException | string |
exception d’état du document |
|
drawerId
|
drawerId | string |
Valeur d’ID du tiroir |
|
taille du fichier
|
fileSize | string |
valeur de taille de fichier |
|
isArchived
|
isArchived | boolean |
est le document archivé |
|
isCheckedOut
|
isCheckedOut | boolean |
est le document extrait |
|
isEncrypted
|
isEncrypted | boolean |
est le document Chiffré |
|
isFiled
|
isFiled | boolean |
est le document déposé |
|
isInRedactionQueue
|
isInRedactionQueue | boolean |
est le document dans la file d’attente de réaction |
|
isInTaxsortQueue
|
isInTaxsortQueue | boolean |
est le document dans la file d’attente Taxsort |
|
isLocked
|
isLocked | boolean |
est le document verrouillé |
|
isOfficeDocument
|
isOfficeDocument | boolean |
est le document d’un document Office |
|
isPublished
|
isPublished | boolean |
est le document publié |
|
isUndergoingMerging
|
isUndergoingMerging | boolean |
est le document en cours de fusion |
|
localFile
|
localFile | string |
est le document un fichier local |
|
noEdit
|
noEdit | boolean |
aucune valeur De modification |
|
Pages
|
pages | integer |
pages dans le document |
|
reviewed
|
reviewed | boolean |
état examiné |
|
taxSort
|
taxSort | boolean |
est le document taxSorted |
|
type
|
type | string |
type de fichier |
|
version
|
version | integer |
version du document |
Obtenir un document
Télécharge le document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Entrer l’ID du document |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Publier l’état du document
Publier ou annuler la publication de documents à partir de ClientFlow.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Entrer l’ID du document |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
IsPublié
|
IsPublished | True | string |
Spécifier true ou false |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentException
|
documentException | string |
exception de document |
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
isPublished
|
isPublished | boolean |
est le document publié |
Rapport de suivi par livrable V2
Rapport de suivi par livrableV2
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
ID du tiroir
|
DrawerId | string |
ID du tiroir |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
Type d’engagement
|
EngagementType | string |
Type d’engagement |
|
|
Flux de travail
|
Workflow | string |
Flux de travail |
|
|
Étape actuelle
|
CurrentStep | string |
Étape actuelle |
|
|
PIC
|
PIC | string |
PIC |
|
|
Affectation
|
AssignedTo | string |
Affectation |
|
|
Affecté sur
|
AssignedOn | string |
Affecté sur |
|
|
Description du flux de travail
|
WorkflowDescription | string |
Description du flux de travail |
|
|
En cours de traitement uniquement
|
InProcessOnly | string |
En cours de traitement uniquement |
|
|
Statut
|
Status | string |
Statut |
|
|
Priority
|
Priority | string |
Priority |
|
|
Reçu le
|
ReceivedOn | string |
Reçu le |
|
|
Terminé le
|
CompletedOn | string |
Terminé le |
|
|
Envoyé sur
|
SentOn | string |
Envoyé sur |
|
|
Responsable
|
Responsible | string |
Responsable |
|
|
Historique des affectations
|
AssignmentHistory | string |
Historique des affectations |
|
|
Reçu de
|
ReceivedFrom | string |
Reçu de |
|
|
Envoyé à
|
SentTo | string |
Envoyé à |
|
|
Terminé par
|
CompletedBy | string |
Terminé par |
|
|
Responsable
|
Accountable | string |
Responsable |
|
|
Date d’échéance actuelle
|
CurrentDueDate | string |
Date d’échéance actuelle |
|
|
Date d’échéance d’origine
|
OriginalDueDate | string |
Date d’échéance d’origine |
|
|
Date étendue
|
DateExtended | string |
Date étendue |
|
|
Jours à l’étape
|
DaysAtStep | string |
Jours à l’étape |
|
|
Nombre total de jours à l’étape
|
TotalDaysAtStep | string |
Nombre total de jours à l’étape |
|
|
Jours entre les routages
|
DaysBetweenRoutings | string |
Jours entre les routages |
|
|
Nombre total de jours en cours de traitement
|
TotalDaysInProcess | string |
Nombre total de jours en cours de traitement |
|
|
Détails du routage
|
RoutingDetails | string |
Détails du routage |
|
|
Dernière mise à jour
|
LastUpdated | string |
Dernière mise à jour |
|
|
Champs d’informations
|
InformationFields | array of string |
Champs d’informations |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Numéro de page
|
PageNumber | string |
Numéro de page |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’enregistrements
|
totalRecords | integer |
Nombre total d’enregistrements |
|
Numéro de page
|
pageNumber | string |
Numéro de page |
|
Taille de page
|
pageSize | integer |
Taille de page |
|
Total Pages
|
totalPages | integer |
Total Pages |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nom du client
|
firmFlowReportResponse.clientName | string |
Nom du client |
|
Numéro de client
|
firmFlowReportResponse.clientNumber | string |
Numéro de client |
|
ID du tiroir
|
firmFlowReportResponse.drawerId | string |
ID du tiroir |
|
Service Type
|
firmFlowReportResponse.serviceType | string |
Service Type |
|
Type d’engagement
|
firmFlowReportResponse.engagementType | string |
Type d’engagement |
|
Flux de travail
|
firmFlowReportResponse.workflow | string |
Flux de travail |
|
Étape actuelle
|
firmFlowReportResponse.currentStep | string |
Étape actuelle |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Affectation
|
firmFlowReportResponse.assignedTo | string |
Affectation |
|
Affecté sur
|
firmFlowReportResponse.assignedOn | string |
Affecté sur |
|
Année
|
firmFlowReportResponse.year | string |
Année |
|
Fin de la période
|
firmFlowReportResponse.periodEnd | string |
Fin de la période |
|
Description du flux de travail
|
firmFlowReportResponse.workflowDescription | string |
Description du flux de travail |
|
Progrès
|
firmFlowReportResponse.progress | string |
Progrès |
|
Statut
|
firmFlowReportResponse.status | string |
Statut |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
EFile Oui ou Non
|
firmFlowReportResponse.eFileYesOrNo | string |
EFile Oui ou Non |
|
Oui ou Non étendu
|
firmFlowReportResponse.extendedYesOrNo | string |
Oui ou Non étendu |
|
Reçu le
|
firmFlowReportResponse.receivedOn | string |
Reçu le |
|
Terminé le
|
firmFlowReportResponse.completedOn | string |
Terminé le |
|
Envoyé sur
|
firmFlowReportResponse.sentOn | string |
Envoyé sur |
|
Livrables
|
firmFlowReportResponse.deliverables | string |
Livrables |
|
Responsable
|
firmFlowReportResponse.responsible | string |
Responsable |
|
Historique des affectations
|
firmFlowReportResponse.assignmentHistory | string |
Historique des affectations |
|
Reçu de
|
firmFlowReportResponse.receivedFrom | string |
Reçu de |
|
Envoyé à
|
firmFlowReportResponse.sentTo | string |
Envoyé à |
|
Terminé par
|
firmFlowReportResponse.completedBy | string |
Terminé par |
|
Responsable
|
firmFlowReportResponse.accountable | string |
Responsable |
|
Date d’échéance actuelle
|
firmFlowReportResponse.currentDueDate | string |
Date d’échéance actuelle |
|
Date d’échéance d’origine
|
firmFlowReportResponse.originalDueDate | string |
Date d’échéance d’origine |
|
Notes de routage
|
firmFlowReportResponse.routingNotes | string |
Notes de routage |
|
PIC Oui ou Non
|
firmFlowReportResponse.picYesOrNo | string |
PIC Oui ou Non |
|
Affecté à Oui ou Non
|
firmFlowReportResponse.assignedToYesOrNo | string |
Affecté à Oui ou Non |
|
Date étendue
|
firmFlowReportResponse.dateExtended | string |
Date étendue |
|
Jours à l’étape
|
firmFlowReportResponse.daysAtStep | string |
Jours à l’étape |
|
Nombre total de jours à l’étape
|
firmFlowReportResponse.totalDaysAtStep | string |
Nombre total de jours à l’étape |
|
Jours entre les routages
|
firmFlowReportResponse.daysBetweenRoutings | string |
Jours entre les routages |
|
Nombre total de jours en cours de traitement
|
firmFlowReportResponse.totalDaysInProcess | string |
Nombre total de jours en cours de traitement |
|
ID du dossier
|
firmFlowReportResponse.folderID | string |
ID du dossier |
|
ID de dépôt
|
firmFlowReportResponse.filingID | string |
ID de dépôt |
|
ID de dépôt précédent
|
firmFlowReportResponse.priorFilingID | string |
ID de dépôt précédent |
|
Dernière mise à jour
|
firmFlowReportResponse.lastUpdated | string |
Dernière mise à jour |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nom
|
firmFlowReportResponse.informationFields.name | string |
nom |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obtenir une exception FirmFlow
|
getFirmFlowException | string |
Obtenir une exception FirmFlow |
Recherche de documents
Charge tous les documents auxquels l’utilisateur a accès dans le tiroir spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
DrawerId
|
DrawerId | string |
Entrer l’ID du tiroir |
|
|
IndexId
|
IndexId | string |
Entrer l’ID d’index |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
|
|
NumberOfRows
|
NumberOfRows | integer |
Entrer le nombre de lignes |
|
|
Numéro de page
|
PageNumber | integer |
Entrer le numéro de page |
|
|
SortField
|
SortField | string |
Entrer le champ de tri |
|
|
SortOrder
|
SortOrder | string |
Entrer l’ordre de tri |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
documentIds
|
documentIds | array of string |
documentIds |
|
documentSearchCount
|
documentSearchCount | integer |
nombre de recherches de document |
Routage du flux de travail V2
Routage du flux de travail V2
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
filingId
|
filingId | array of integer |
filingId |
|
|
CurrentStep
|
CurrentStep | array of string |
CurrentStep |
|
|
Exécuter
|
Complete | boolean |
Exécuter |
|
|
Date de fin
|
CompletedDate | string |
Date de fin |
|
|
Étape suivante
|
NextStep | string |
Étape suivante |
|
|
Affectation
|
AssignedTo | string |
Affectation |
|
|
Date affectée
|
AssignedDate | string |
Date affectée |
|
|
Priority
|
Priority | string |
Priority |
|
|
Statut
|
Status | string |
Statut |
|
|
Note de routage
|
RoutingNote | string |
Note de routage |
|
|
Notification par e-mail
|
emailNotify | boolean |
Notification par e-mail |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de classement
|
filingId | string |
ID de classement |
|
Est routé
|
isRouted | boolean |
Est routé |
Réindexation du document
Réindexe les documents
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Entrer l’ID d’index |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
isReIndexed
|
isReIndexed | boolean |
est le document ReIndexed |
|
reIndexDocumentException
|
reIndexDocumentException | string |
exception de document reIndex |
Suivi du rapport par flux de travail
Suivi du rapport par flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
ID du tiroir
|
DrawerId | string |
ID du tiroir |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
Type d’engagement
|
EngagementType | string |
Type d’engagement |
|
|
Flux de travail
|
Workflow | string |
Flux de travail |
|
|
Étape actuelle
|
CurrentStep | string |
Étape actuelle |
|
|
PIC
|
PIC | string |
PIC |
|
|
Affectation
|
AssignedTo | string |
Affectation |
|
|
Affecté sur
|
AssignedOn | string |
Affecté sur |
|
|
Description du flux de travail
|
WorkflowDescription | string |
Description du flux de travail |
|
|
En cours de traitement uniquement
|
InProcessOnly | string |
En cours de traitement uniquement |
|
|
Statut
|
Status | string |
Statut |
|
|
Priority
|
Priority | string |
Priority |
|
|
Responsable
|
Responsible | string |
Responsable |
|
|
Historique des affectations
|
AssignmentHistory | string |
Historique des affectations |
|
|
Reçu de
|
ReceivedFrom | string |
Reçu de |
|
|
Reçu le
|
ReceivedOn | string |
Reçu le |
|
|
Envoyé à
|
SentTo | string |
Envoyé à |
|
|
Envoyé sur
|
SentOn | string |
Envoyé sur |
|
|
Terminé par
|
CompletedBy | string |
Terminé par |
|
|
Terminé le
|
CompletedOn | string |
Terminé le |
|
|
Date d’échéance actuelle
|
CurrentDueDate | string |
Date d’échéance actuelle |
|
|
Jours à l’étape
|
DaysAtStep | string |
Jours à l’étape |
|
|
Nombre total de jours à l’étape
|
TotalDaysAtStep | string |
Nombre total de jours à l’étape |
|
|
Jours entre les routages
|
DaysBetweenRoutings | string |
Jours entre les routages |
|
|
Nombre total de jours en cours de traitement
|
TotalDaysInProcess | string |
Nombre total de jours en cours de traitement |
|
|
Responsable
|
Accountable | string |
Responsable |
|
|
Détails du routage
|
RoutingDetails | string |
Détails du routage |
|
|
Dernière mise à jour
|
LastUpdated | string |
Dernière mise à jour |
|
|
Champs d’informations
|
InformationFields | array of string |
Champs d’informations |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Numéro de page
|
PageNumber | string |
Numéro de page |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’enregistrements
|
totalRecords | integer |
Nombre total d’enregistrements |
|
Numéro de page
|
pageNumber | string |
Numéro de page |
|
Taille de page
|
pageSize | integer |
Taille de page |
|
Total Pages
|
totalPages | integer |
Total Pages |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nom du client
|
firmFlowReportResponse.clientName | string |
Nom du client |
|
Numéro de client
|
firmFlowReportResponse.clientNumber | string |
Numéro de client |
|
ID du tiroir
|
firmFlowReportResponse.drawerId | string |
ID du tiroir |
|
Service Type
|
firmFlowReportResponse.serviceType | string |
Service Type |
|
Type d’engagement
|
firmFlowReportResponse.engagementType | string |
Type d’engagement |
|
Flux de travail
|
firmFlowReportResponse.workflow | string |
Flux de travail |
|
Étape actuelle
|
firmFlowReportResponse.currentStep | string |
Étape actuelle |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Affectation
|
firmFlowReportResponse.assignedTo | string |
Affectation |
|
Affecté sur
|
firmFlowReportResponse.assignedOn | string |
Affecté sur |
|
Année
|
firmFlowReportResponse.year | string |
Année |
|
Fin de la période
|
firmFlowReportResponse.periodEnd | string |
Fin de la période |
|
Description du flux de travail
|
firmFlowReportResponse.workflowDescription | string |
Description du flux de travail |
|
Progrès
|
firmFlowReportResponse.progress | string |
Progrès |
|
Statut
|
firmFlowReportResponse.status | string |
Statut |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
EFile Oui ou Non
|
firmFlowReportResponse.eFileYesOrNo | string |
EFile Oui ou Non |
|
Oui ou Non étendu
|
firmFlowReportResponse.extendedYesOrNo | string |
Oui ou Non étendu |
|
Reçu le
|
firmFlowReportResponse.receivedOn | string |
Reçu le |
|
Terminé le
|
firmFlowReportResponse.completedOn | string |
Terminé le |
|
Envoyé sur
|
firmFlowReportResponse.sentOn | string |
Envoyé sur |
|
Livrables
|
firmFlowReportResponse.deliverables | string |
Livrables |
|
Responsable
|
firmFlowReportResponse.responsible | string |
Responsable |
|
Historique des affectations
|
firmFlowReportResponse.assignmentHistory | string |
Historique des affectations |
|
Reçu de
|
firmFlowReportResponse.receivedFrom | string |
Reçu de |
|
Envoyé à
|
firmFlowReportResponse.sentTo | string |
Envoyé à |
|
Terminé par
|
firmFlowReportResponse.completedBy | string |
Terminé par |
|
Responsable
|
firmFlowReportResponse.accountable | string |
Responsable |
|
Date d’échéance actuelle
|
firmFlowReportResponse.currentDueDate | string |
Date d’échéance actuelle |
|
Date d’échéance d’origine
|
firmFlowReportResponse.originalDueDate | string |
Date d’échéance d’origine |
|
Notes de routage
|
firmFlowReportResponse.routingNotes | string |
Notes de routage |
|
PIC Oui ou Non
|
firmFlowReportResponse.picYesOrNo | string |
PIC Oui ou Non |
|
Affecté à Oui ou Non
|
firmFlowReportResponse.assignedToYesOrNo | string |
Affecté à Oui ou Non |
|
Date étendue
|
firmFlowReportResponse.dateExtended | string |
Date étendue |
|
Jours à l’étape
|
firmFlowReportResponse.daysAtStep | string |
Jours à l’étape |
|
Nombre total de jours à l’étape
|
firmFlowReportResponse.totalDaysAtStep | string |
Nombre total de jours à l’étape |
|
Jours entre les routages
|
firmFlowReportResponse.daysBetweenRoutings | string |
Jours entre les routages |
|
Nombre total de jours en cours de traitement
|
firmFlowReportResponse.totalDaysInProcess | string |
Nombre total de jours en cours de traitement |
|
ID du dossier
|
firmFlowReportResponse.folderID | string |
ID du dossier |
|
ID de dépôt
|
firmFlowReportResponse.filingID | string |
ID de dépôt |
|
Dernière mise à jour du flux de travail
|
firmFlowReportResponse.workflowLastUpdated | string |
Dernière mise à jour du flux de travail |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nom
|
firmFlowReportResponse.informationFields.name | string |
nom |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obtenir une exception FirmFlow
|
getFirmFlowException | string |
Obtenir une exception FirmFlow |
Supprimer des flux de travail
Supprimer des flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
filingId
|
filingId | array of integer |
filingId |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État supprimé
|
isDeleted | boolean |
État supprimé |
|
ID de classement
|
filingId | string |
ID de classement |
Supprimer l'utilisateur
Supprimer des utilisateurs GoFileRoom et ClientFlow du système
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
LoginId
|
LoginId | string |
Entrez l’ID de connexion de l’utilisateur |
|
|
Type d'utilisateur
|
UserType | string |
Entrez le type d’utilisateur |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
deleteUserException
|
deleteUserException | string |
supprimer une exception utilisateur |
|
isDeleted
|
isDeleted | boolean |
La connexion a-t-elle été supprimée |
|
loginId
|
loginId | string |
valeur d’ID de connexion |
Supprimer le livrable principal
Supprimer le livrable principal
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
Service Type
|
ServiceType | string |
Service Type |
|
|
Nom du tiroir
|
DrawerName | string |
Nom du tiroir |
|
|
LivrableNames
|
DeliverableNames | array of string |
LivrableNames |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Supprimer l’état
|
isDeleted | boolean |
Supprimer l’état |
|
Message de réponse
|
responseMessage | string |
Message de réponse |
Supprimer un document
Supprime un document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Entrer l’ID du document |
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
deleteDocumentException
|
deleteDocumentException | string |
Supprimer une exception de document |
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
isDeleted
|
isDeleted | boolean |
est le document supprimé |
Taxsort Document
Document PDF Taxsort
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
body
|
body | array of string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Valeur d’ID de document |
|
isTaxSorted
|
isTaxSorted | boolean |
Is the document TaxSorted |
|
taxsortDocumentException
|
taxsortDocumentException | string |
exception de document taxsort |
Valider le jeton
Valider l’état du jeton
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
Retours
- response
- boolean
Valider les index
Vérifie si les index fournis sont valides.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
X-Authorization | string |
Authentification par jeton |
|
|
DrawerId
|
DrawerId | string |
Entrer l’ID du tiroir |
|
|
IndexId
|
IndexId | string |
Entrer l’ID d’index |
|
|
IndexValue
|
IndexValue | string |
Entrer la valeur d’index |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
errorMessage
|
errorMessage | string |
message d'erreur |
|
Erreurs
|
errors | array of |
Erreurs |
|
isValid
|
isValid | boolean |
est l’index valide |
Définitions
ficelle
Il s’agit du type de données de base « string ».
boolean
Il s’agit du type de données de base « boolean ».