HighQ (préversion)

Ce connecteur permet un accès sécurisé et authentifié aux API HighQ, ce qui permet l’intégration transparente des fonctionnalités de collaboration et de gestion de contenu aux workflows et applications personnalisés. Il prend en charge l’automatisation des documents, la synchronisation des données et l’orchestration des flux de travail, ce qui permet aux équipes de services juridiques et professionnels de simplifier les opérations, de réduire les efforts manuels et d’améliorer la productivité.

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	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Messagerie électronique	highq-support@thomsonreuters.com

Métadonnées du connecteur
Éditeur	Thomson Reuters Incorporated
Site web	https://legal.thomsonreuters.com/en/products/highq
Politique de confidentialité	https://www.thomsonreuters.com/en/privacy-statement
Catégories	Collaboration; Contenu et fichiers

HighQ

Aperçu

HighQ fournit un accès transparent, sécurisé et authentifié aux API HighQ. Ce connecteur permet une interaction transparente avec différents services HighQ, notamment le module ISheet, les API de ressource de document, l’API d’administration ISheet et les opérations utilisateur. Il est conçu pour faciliter l’intégration à la plateforme HighQ Collaborate, offrant des fonctionnalités telles que la récupération et la création d’éléments iSheet, la gestion des fichiers de documents et l’administration des comptes d’utilisateur.

Version du connecteur : 1.0.0
Titre: HighQ
Description: Ce connecteur offre un accès transparent, sécurisé et authentifié aux API HighQ.
Contact:
- Nom: Highq
- Site Web :HighQ Support
- Messagerie électronique:highq-support@thomsonreuters.com

Authentication

Le connecteur tire parti des variables d’environnement dynamiques pour une connectivité sécurisée :

Hôte : @environmentVariables("highqt_host")
Chemin d’accès de base : /@environmentVariables("highqt_instancename")/api
ID client :@environmentVariables("highqt_clientid")
Clé secrète client :@environmentVariables("highqt_clientsecret")

Pour obtenir des procédures d’authentification détaillées, reportez-vous au portail du support technique HighQ ou contactez le support HighQ.

Opérations du connecteur

ISheet Module

Récupérer des éléments iSheet
GET /{version}/isheet/{isheetid}/items
Récupère une liste d’éléments dans la feuille iSheet spécifiée.
Créer des éléments iSheet
POST /{version}/isheet/{isheetid}/items
Insère de nouveaux éléments dans une feuille iSheet, avec prise en charge de plusieurs iSheets et du suivi de l’état via des clés progressives.

API de ressource de document

Récupérer des informations sur le fichier
GET /{version}/files/{fileid}
Récupère des informations détaillées sur un fichier spécifique sur la plateforme HighQ Collaborate.
Charger un fichier
POST /{version}/files/content
Charge un fichier dans un dossier spécifié, prenant en charge les chargements segmentés lorsque l’en-tête Content-Range est fourni.
Récupérer la liste des dossiers
GET /{version}/folders/{folderid}/items
Récupère une liste de dossiers dans le dossier spécifié avec prise en charge du tri et de la pagination.

API d’administration ISheet

Récupérer des colonnes iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Récupère les configurations de colonne d’une feuille iSheet donnée.

Opérations utilisateur

Récupérer des utilisateurs
GET /{version}/users
Récupère une liste d’utilisateurs avec prise en charge du filtrage, de la pagination et des rôles d’utilisateur détaillés.
Ajouter un nouvel utilisateur
POST /{version}/users
Crée un compte d’utilisateur avec des attributs étendus et une validation.
Archiver un utilisateur
DELETE /{version}/users/{userid}
Archive un utilisateur existant à partir du système.

Gestion des documents et des sites

Créer un dossier
POST /{version}/folders
Crée un dossier sous un dossier parent spécifié.
Déplacer des documents
PUT /{version}/files/move
Déplace un ou plusieurs fichiers d’un dossier vers un autre dans le même site.
Opérations de gestion de site :
- Ajouter un groupe existant au site : POST /{version}/sites/{siteid}/groups/{groupid}
- Mettre à jour le groupe de sites : PUT /{version}/sites/{siteid}/groups/{groupid}
- Ajoutez un nouveau site : POST /{version}/sites

Getting Started

Configuration :
- Définissez les variables highqt_host d’environnement et highqt_instancename dans votre environnement Power Platform.
Authentification :
- Suivez les instructions fournies par HighQ pour configurer l’authentification sécurisée pour les demandes d’API.
Utilisation :
- Importez highQ dans votre instance Power Platform.
- Utilisez les opérations disponibles en fonction des besoins. Reportez-vous aux résumés des opérations fournies ci-dessus pour obtenir des conseils.

Paramètres et paramètres

Paramètres de chemin d’accès :
Incluez les paramètres requis tels que version, , isheetidfileid, folderidet userid le cas échéant.
Paramètres de requête :
Les paramètres facultatifs tels que sheetviewid, sortcolumnid, limitet offset sont disponibles pour affiner les réponses d’API.
Paramètres du corps :
Pour les opérations qui nécessitent un corps de requête (par exemple, la création d’éléments iSheet ou d’utilisateurs), assurez-vous que la requête respecte les schémas définis (tels que isheetDBO, FolderDBOou IntegrationUserDBO).

Résolution des problèmes et limitations

Codes d’erreur :
Les codes d’état HTTP standard sont utilisés entre les opérations :
- 200 pour les opérations réussies
- 401 pour un accès non autorisé
- 403 pour les échecs interdits ou de validation
- 405 pour les méthodes HTTP non valides
- 500 pour les erreurs de serveur interne
  Reportez-vous à la documentation de l’API individuelle pour obtenir des descriptions d’erreurs détaillées.
Limitations :
Certains points de terminaison peuvent avoir des limites par défaut (par exemple, 100 enregistrements par défaut limit ). Des paramètres supplémentaires peuvent être nécessaires pour trier et filtrer des jeux de données volumineux.

Ressources additionnelles

Pour plus d’informations et de documentation étendue, consultez :

Support technique HighQ
Documentation interne qui accompagne le package de connecteur HighQ.

Licences et support

Pour plus d’informations sur les licences et le support technique :

Contact : Highq
URL de support : Support technique HighQ
E-mail de support : highq-support@thomsonreuters.com

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Ajouter un groupe existant au site

Cette méthode API ajoute un groupe système existant au site.
Cette API a été étendue pour ajouter des groupes d’utilisateurs de base système existants (de type système/organisation) dans le site.

Ajouter un site

Utilisez cette API pour créer un site. L’objet de site prend uniquement en charge les attributs visibles dans l’interface de création de site.

Cette API nécessite un nom de site (et des champs obligatoires configurés au niveau ASP le cas échéant) pour créer un site.

La balise « module » représente un module différent à configurer sur le site, comme indiqué dans les attributs de demande.
Pour créer un site à partir d’un modèle en passant la balise « sitetemplateid »
- Pour moins de la version 7, si aucun module n’est donné (« balise module » n’est pas passé) dans la demande, la configuration du module de modèle aura lieu. Si la balise de module est fournie avec la configuration, elle respecte celle-ci et la configure comme indiqué dans la demande (plutôt que d’utiliser la configuration du module de modèle)
- Pour une version supérieure à la version 7, si un module est attribué à la balise (« module » est transmis) ou non dans la demande, la configuration du module de modèle aura lieu.

Cette méthode ne prend pas en charge le chargement de l’image de site dans cet appel, la prise en charge de l’icône de site est fournie en tant qu’appel distinct.
L’appel de méthode attend un ID de catégorie existant. L’ID de catégorie doit être obtenu par l’application appelante par un appel antérieur à l’interface des catégories de site. Si aucune catégorie n’est donnée dans la requête, aucune catégorie (aucune catégorie réelle) n’est ajoutée par défaut.

La date de début et de fin du site doit être au format « dd MMM aaaa » et n’est pas UTC. Le client d’API demande toujours la date réelle.

« landingpage » a la valeur par défaut « fichiers (dossier racine) ».
La « page d’atterrissage » s’attend à trois formulations ou identifications différentes pour le module Fichier. Les valeurs possibles sont les suivantes :
- fichiers (dossier racine)
- fichiers (activité récente)
- fichiers (recherche avancée)
L’implémentation de méthode prend désormais en charge (à partir de la version 5.1) le nom de site multilingue. Le nom< de site de l’API version 6 ou ultérieure >représente dans le corps de la demande en fonction de l’ordre de préférence de l’utilisateur. Le nom< de site de l’API version 5 ou antérieure >représente l’anglais britannique par défaut.
<sitenametranslations> représente les noms de site dans chaque langue (qui sera une balise supplémentaire dans « API Object lui-même » à partir de la version 5.1) de l’API version 6 ou ultérieure, dans le corps de la demande, ils envoient les deux balises, c’est-à-dire les <noms de site et >les noms< de site,> alors nous devons valider les valeurs, par exemple, <le nom> de site doit correspondre à la balise de traduction< respective >en termes de préférence de langue de l’utilisateur. L’API 7 ou une version ultérieure, le site créé à partir du modèle suit les modules du modèle source et ignore la liste des modules envoyée dans le corps de la demande.

L’implémentation de méthode prend désormais en charge la création d’un site à partir d’un modèle en fournissant une balise « sitetemplateid » (ancienne approche)

Notez que la prise en charge de la création d’un site à partir d’un modèle à l’aide de cette API sera déconseillée ultérieurement. Pour créer un site à partir d’un modèle, utilisez la nouvelle API Créer un site à partir d’un modèle (/sites/modèles/{templateid}/site) qui est une API d’interrogation longue (qui prend en charge les demandes de longue durée)

Cette méthode prend en charge plusieurs numéros de matière à ajouter au site à l’aide de la version 10 de l’API. La balise « matternos » indique plusieurs nombres de matières avec lecture seule ou non. La version antérieure (inférieure à la version 10) du numéro de matière unique « matterno » reflète le premier nombre de matières qui existait plusieurs numéros de matière dans le site.

Version 18 : une catégorie (usage du site) est requise. Si l’objectif du site est masqué, un message s’affiche ; sinon, les objectifs du site masqué ne sont pas ajoutés au site.

Jusqu’à la version 17 : le propriétaire du site est l’utilisateur connecté ; aucun autre utilisateur ne peut être ajouté.

Version 18 : le propriétaire du site peut ajouter d’autres utilisateurs au site.

À partir de la version 19 de l’API, un nouveau module est introduit sous le nom de « customPages » qui est étroitement couplé au module d’accueil. Par conséquent, si la valeur du module d’accueil est True, customPages sera vraie et inversement.

Ajouter un utilisateur

Cet appel d’API est utilisé pour ajouter un nouvel utilisateur au système.
Remarque :
1. Ajout de la prise en charge des nouveaux champs suivants
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. La balise d’adresse a été ajoutée dans l’API version 4

Résumé	Code ref (avant V4)	Code ref (V4)
L’adresse e-mail est requise	101	101
Adresse e-mail non valide	104	104
Le prénom est obligatoire	102	102
Le nombre maximal de caractères autorisés pour le prénom doit être compris entre 1 et 100	102	352
L’adresse e-mail du secrétaire/assistant n’est pas valide	104	353
L’état doit être actif ou inactif	116	116
Le service entré ne peut pas comporter plus de 256 caractères	N/A	354
L’attribut ifpartner entré n’est pas valide	N/A	355
L’attribut systemuser entré n’est pas valide	N/A	356
L’attribut usertypeid entré n’est pas valide	N/A	357
L’attribut langcode entré n’est pas valide	N/A	358
L’attribut sourcetype entré n’est pas valide. Les valeurs valides sont System, Active Directory ou System default.	N/A	359
Entrez le numéro de téléphone valide	N/A	360
Entrez un numéro de téléphone valide au format {countrycode} ${areacode}${number}.	N/A	361
Entrez un numéro mobile valide au format {countrycode}${number}.	N/A	362
Entrez un code de pays de téléphone de bureau valide	N/A	363
Le code de pays du téléphone de bureau peut avoir un maximum de 4 chiffres	N/A	364
Entrez un code de zone téléphonique de bureau valide	N/A	365
Le code de zone téléphonique du bureau peut avoir un maximum de 5 chiffres	N/A	366
Le numéro de téléphone du bureau doit comporter au maximum 15 chiffres	N/A	368
Entrer un code de pays de téléphone mobile valide	N/A	369
Le code de pays du téléphone mobile peut avoir un maximum de 4 chiffres	N/A	372
Entrez un numéro mobile valide	N/A	373
Le numéro de téléphone mobile doit comporter au maximum 20 chiffres	N/A	374
Le domaine n’existe pas	105	105
L’e-mail existe déjà dans le système	111	111
Mentionner l’organisation en cas de domaine auto-inscrit	187	187
Mentionner l’organisation en cas de domaine exceptionnel	115	115
L’ID d’organisation n’est pas au format approprié	112	112
L’organisation n’existe pas	01:23:06 AM	01:23:06 AM
Le domaine existe dans d’autres organisations	114	114
L’ID d’adresse entré n’est pas valide	N/A	308
Nom du lien social introuvable dans le système.	N/A	375
Le nom du lien social est requis	N/A	376
La valeur du lien social est requise	N/A	377
Les caractères maximum pour la valeur de lien social doivent être compris entre 1 et 500	N/A	378
Entrez le nom du lien personnalisé	N/A	379
Valeur de lien personnalisée requise	N/A	380
Les caractères maximal pour le nom de lien personnalisé doivent être compris entre 1 et 500	N/A	381
Les caractères maximal pour la valeur de lien personnalisée doivent être compris entre 1 et 500	N/A	382
Nom du lien de message requis	N/A	383
Nom du lien de message introuvable dans le système	N/A	384
Valeur de lien de message requise	N/A	385
Les caractères maximal pour la valeur du lien de message doivent être compris entre 1 et 500	N/A	386
Le lien social est désactivé	N/A	408
Le lien de message est désactivé	N/A	409
Le lien personnalisé est désactivé	N/A	410

Ticket JIRA : https://dev.highq.com/jira/browse/COL-65685

Archiver l’utilisateur

Cet appel d’API est utilisé pour archiver un utilisateur au sein du système.

Codes d’erreur

Résumé	Code ref (avant V4)	Code ref (V4)
Les utilisateurs suivants n’existent pas dans le système	110	110
Un ID d’utilisateur est requis	109	109
L’ID utilisateur n’est pas au format approprié	113	113
La longueur de l’ID de l’utilisateur ne peut pas dépasser 50 caractères	N/A	304

Ticket JIRA : https://dev.highq.com/jira/browse/COL-67441

Charger un fichier

Cet appel d’API charge un fichier dans un dossier spécifié sur la plateforme HighQ Collaborate. Il prend en charge les chargements segmentés lorsque l’en-tête Content-Range est fourni.

Créer un dossier

Cette API crée un dossier dans le site spécifié. Il vous permet de fournir les détails du dossier et de s’assurer que le dossier est créé sous le dossier parent donné.

Déplacer des documents

Cette API déplace plusieurs fichiers d’un dossier vers un autre au sein du même site.

Mettre à jour le groupe de sites

Cette méthode d’API met à jour le nom d’un groupe existant dans un site.
Cette API a été étendue pour mettre à jour le nom d’un groupe d’utilisateurs de base existant dans un site.

Mettre à jour le site

Utilisez ce point de terminaison d’API pour mettre à jour les détails d’un site existant. L’API prend en charge les mêmes champs que ceux utilisés dans l’API Créer un site.

Cette méthode prend en charge plusieurs numéros de matière à ajouter au site à l’aide de la version 10 de l’API. La balise « matternos » indique plusieurs nombres de matières avec lecture seule ou non.

Version 18 : une catégorie (usage du site) est requise. Si l’objectif du site est masqué, un message s’affiche ; sinon, les objectifs du site masqué ne sont pas ajoutés au site.

Désormais, le propriétaire du site peut également être affecté à d’autres utilisateurs, mais il doit être des participants au site et avoir un rôle supérieur à celui de l’administrateur de site.

Version 18 : le propriétaire du site peut ajouter d’autres utilisateurs au site.

À partir de la version 19 de l’API, un nouveau module appelé customPages est introduit, qui est étroitement couplé au module d’accueil. Si la valeur du module d’accueil est True, customPages doit être true et vice versa.

Notez que toutes les propriétés/éléments de la réponse de site get ne sont pas pouvant être mises à jour/insérables. Consultez le tableau ci-dessous pour savoir qui sont en lecture seule, pouvant être mis à jour ou insérés.

Obtenir des informations sur les dossiers

La méthode fournit des détails de dossier de l’ID de dossier donné.

Pour créer l’élément iSheet

Cet appel d’API est utilisé pour insérer un élément iSheet. Plusieurs feuilles iSheet peuvent être prises en charge.

Pour obtenir l’état d’un élément iSheet basé sur une clé progressive, appelez API POST /api/3/progressivekeystatus/{progressive_key}

par exemple POST /api/{version}/progressivekeystatus/{progressive_key}

Nom	Type	Descriptif
progressive_key	Chaîne	Clé pour vérifier l’état de votre action.

Réponse


              
              <progressivekeyresponse>

               Éléments \t<>

                \t\t<item>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\<>status SUCCESS</status>

                 \t\t\t<statuscode>200</statuscode>

                 \t\t\t<message>Record ajouté avec succès</message>

                \t\t</item>

                \t\t<item>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\<>status SUCCESS</status>

                 \t\t\t<statuscode>200</statuscode>

                 \t\t\t<message>Record ajouté avec succès</message>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Récupérer des colonnes iSheet

Cet appel d’API récupère les colonnes associées à la feuille iSheet spécifiée. Cette fonctionnalité est prise en charge dans l’API version 3 et ultérieure.

Récupérer la liste des utilisateurs

Récupérer une liste d’utilisateurs Cette API récupère une liste d’utilisateurs à partir du système. Fonctionnalités clés ## - Récupérer les détails de l’utilisateur avec plusieurs options de filtrage - Prend en charge la pagination avec `limit` et `offset` - Nouveaux paramètres de requête et champs introduits dans les versions récentes - Réponse structurée avec les rôles d’utilisateur et les attributs ## Nouveaux paramètres de requête (Version-Specific) - Introduit dans V12 : - `systemAdminSearch`: Quand la `1`valeur est définie, retourne uniquement les utilisateurs avec le rôle Administrateur système. - Introduit dans V18 : : `userid`accepte les valeurs séparées par des virgules (CSV). Mises à jour du corps de la réponse ## - Nouveaux champs ajoutés : - `emaildomain`, `org`, `invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, , , `publicprofile`# `dateOfBirth` # # Format de modification (à partir de V11) - La `location` balise a été renommée pour `address` cohérence. - Exemple de réponse : `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Rôles d’utilisateur (introduits dans l’API V11+) - Exemple de réponse : `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limites et décalages - Comportement limite : - Valeur par défaut : `100` si aucune valeur n’est fournie. - Permet `-1` de retourner tous les enregistrements. - Si la valeur est inférieure `-1`à , la valeur par défaut est `100`. - Comportement de décalage : - Valeur par défaut : `0` si aucune valeur n’est fournie. - Si le décalage dépasse le nombre total d’enregistrements, la valeur par défaut est revenir à `0`. ## Nouveaux rôles introduits - V12 : `Basic User`, `Allow user to bypass XSS protection` - V14 : `Allow user to manage Contract Express system groups` ## Codes d’erreur | Résumé | Code ref (avant V4) | Code ref (V4) | |---------|----------------------|--------------| | | Entrée non valide pour l’état utilisateur (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | L’ID d’organisation n’est pas valide | N/A | 260 | | | Valeur non valide `neverinvited` (true/false) | N/A | 387 | | | Valeur non valide `neverlogin` (true/false) | N/A | 388 | | | Valeur non valide `groupids` | N/A | 214 | | | Valeur non valide `notingroup` (true/false) | N/A | 389 | | Non valide `ordertype` (pris en charge : nom, organisation, état, etc.) | N/A | 289 | | Non valide `orderby` (pris en charge : asc, desc) | N/A | 290 | | | Valeur non valide `offset` | 138 | 138 | | Valeur non valide `limit` | 137 | 137 | ## Remarques - À partir de V13, cette API est ouverte pour tous les utilisateurs (précédemment limités aux administrateurs système). - À partir de la version 18, le `userregistered2FA` champ indique si un utilisateur s’est inscrit pour 2FA. --- Cette description suit la mise en forme de schéma Swagger 2.0 et doit être placée dans le champ de description dans le schéma du connecteur personnalisé.

Récupérer les informations de fichier

Cet appel d’API récupère des informations détaillées pour un fichier spécifié à partir de la plateforme HighQ Collaborate.

Récupérer une liste de dossiers

Cet appel d’API récupère une liste de dossiers contenus dans le dossier spécifié. Le paramètre « limit » définit le nombre maximal d’éléments à retourner et le paramètre « offset » spécifie la position de départ pour la récupération des données. Les valeurs par défaut sont appliquées si ces paramètres sont omis et que les dossiers sont retournés par ordre croissant par date de création.

Récupérer une liste d’éléments iSheet

Cet appel d’API récupère une liste d’éléments contenus dans la feuille iSheet spécifiée.

Ajouter un groupe existant au site

ID d’opération :: addExistingGroupToSite

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	version
ID du site	siteid	True	string	ID du site.
ID du groupe système	groupid	True	string	ID du groupe système à ajouter au site.

Retours

Corps: sitegroup

Ajouter un site

ID d’opération :: createSite

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API demandée	version	True	string	version de l’API
pièce d'identité	id		integer	Identificateur de site.
nom_site	sitename		string	Le nom du site.
role	role		string	Rôle du site.
sitedescription	sitedescription		string	Description du site.
enabledmodules	enabledmodules		string	Liste des modules activés pour le site.
sitefolderID	sitefolderID		string	Identificateur du dossier du site.
sitefolderpermission	sitefolderpermission		string	Niveau d’autorisation pour le dossier du site.
Activer	enable		string	Activer l’état de HomeDBO.
Activer	enable		string	Activer l’état de ActivityDBO.
microblog	microblog		string	Contenu de microblog associé à ActivityDBO.
docid	docid		string	ID de document.
blogTitle	blogTitle		string	Titre du billet de blog.
blogContent	blogContent		string	Contenu du billet de blog.
showComment	showComment		integer	affichez le commentaire.
tagList	tagList		array of string	Liste des balises associées au blog.
status	status		integer	état du billet de blog.
siteID	siteID		integer	Identificateur du site associé.
author	author		string	Auteur du blog.
categoryList	categoryList		array of string	Catégories affectées au billet de blog.
notificationTypeID	notificationTypeID		integer	Identificateur du type de notification.
Message	message		string	Contenu du message lié au blog.
messageCode	messageCode		integer	Code associé au message.
identifiant externe	externalID		string	Identificateur externe lié au blog.
publishDate	publishDate		string	Date de publication du blog.
processtype	processtype		string	Type de processus associé au blog.
Activer	enable		string	Activer l’état pour BlogDBO.
wikiid	wikiid		integer	Identificateur unique pour le wiki.
currentversionid	currentversionid		integer	Identificateur de la version actuelle du wiki
parentwikiid	parentwikiid		integer	Identificateur du wiki parent.
wikititle	wikititle		string	Titre du wiki.
wikicontent	wikicontent		string	Contenu du wiki.
showcomment	showcomment		integer	Indiquant si les commentaires sont activés.
createddate	createddate		string	Date de création du wiki.
modifieddate	modifieddate		string	Date de dernière modification du wiki.
taglist	taglist		string	Liste séparée par des virgules des balises associées au wiki.
wikipath	wikipath		string	Chemin d’accès au wiki.
wikidraftid	wikidraftid		integer	Identificateur de la version brouillon du wiki.
brouillon	drafttype		string	Type de brouillon associé au wiki.
status	status		integer	État actuel du wiki.
wikiversionid	wikiversionid		integer	Identificateur de version du wiki.
index	index		string	Index ou identificateur de la tâche.
parenttaskid	parenttaskid		integer	Identificateur de la tâche parente.
taskid	taskid		integer	Identificateur unique de la tâche.
title	title		string	Titre de la tâche.
descriptif	description		string	Description détaillée de la tâche.
duedate	duedate		string	Date d’échéance de la fin de la tâche.
startdate	startdate		string	Date de début de la tâche.
mattermaptaskid	mattermaptaskid		string	Identificateur lié à la tâche de mappage de matière.
type	type		string	Type ou catégorie de la tâche.
dependenton	dependenton		string	Les tâches dont dépend cette tâche.
daysfromdependent	daysfromdependent		string	Nombre de jours à partir de la tâche dépendante.
ignoreweekend	ignoreweekend		integer	Indique si les week-ends sont ignorés dans la planification.
duration	duration		integer	Durée d’exécution de la tâche.
resource	resource		string	Ressources affectées à la tâche.
eventTitle	eventTitle		string	Titre de l’événement.
eventContent	eventContent		string	Contenu de l’événement.
showComment	showComment		integer	Indiquant si les commentaires sont activés pour l’événement.
tagList	tagList		array of string	Liste des balises associées à l’événement.
status	status		integer	État actuel de l’événement.
siteID	siteID		integer	Identificateur du site.
contacter	contact		string	Informations de contact pour l’événement.
categoryList	categoryList		array of string	Catégories sous lesquelles l’événement est répertorié.
notificationTypeID	notificationTypeID		integer	Type de notification lié à l’événement.
Message	message		string	Message de l’événement.
messageCode	messageCode		integer	Code de message de l’événement.
identifiant externe	externalID		string	Identificateur externe.
date de début	startDate		string	Date de début de l’événement.
date de fin	endDate		string	Date de fin de l’événement.
startTime	startTime		string	Heure de début de l’événement.
endTime	endTime		string	Heure de fin de l’événement.
location	location		string	Emplacement de l’événement.
author	author		string	Auteur de l’événement.
processtype	processtype		string	Heure de processus de l’événement.
Activer	enable		string	Activez l’événement.
pièce d'identité	id		integer	Identificateur unique de la feuille iSheet.
title	title		string	Titre de la feuille iSheet.
descriptif	description		string	Description de la feuille isheet.
status	status		string	État de la feuille isheet.
accesstype	accesstype		string	Type d’accès de la feuille isheet.
type	type		string	Type de la feuille isheet.
viewlink	viewlink		string	Lien pour afficher la feuille iSheet.
allowsections	allowsections		string	Indique si les sections sont autorisées.
allowlookup	allowlookup		string	Indique si les champs de recherche sont activés.
displayisheet	displayisheet		string	Options d’affichage de la feuille iSheet.
searchasdefaultview	searchasdefaultview		string	Indique si la recherche est en mode par défaut.
enableversion	enableversion		string	Indicateur activé pour le contrôle de version.
enablesheetalerter	enablesheetalerter		string	Indicateur pour activer les alertes de feuille.
alertercondition	alertercondition		string	Conditions pour déclencher des alertes.
overrideitemmodifieddate	overrideitemmodifieddate		string	Remplacer l’indicateur de date de modification.
enablebulkinsertupdate	enablebulkinsertupdate		string	Activez l’insertion/mise à jour en bloc.
fielddescriptions	fielddescriptions		string	Descriptions des champs de l’iSheet.
enablerowlocking	enablerowlocking		string	Activer le verrouillage au niveau des lignes.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Tronquer l’indicateur de texte multiligne.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limite de caractères pour la troncation multiligne.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Autorisez la réutilisation des valeurs de liste de choix.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Autorisez la réutilisation des valeurs de liste de score.
allowIsheetComments	allowIsheetComments		string	Autoriser les commentaires dans iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limite des enregistrements autorisés à partager.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Limite de partage d’enregistrements activée.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Activez le partage de formulaires pour l’ajout d’enregistrements.
recordcount	recordcount		string	Nombre d’enregistrements actuel.
sheettypeid	sheettypeid		integer	ID de type de la feuille iSheet
Activer	enable		string	Activer la fonctionnalité DQ.
userid	userid		integer	Identifiant utilisateur.
Messagerie électronique	email		string	adresse courriel.
httpavatar	httpavatar		string	URL HTTP de l’avatar.
avatar	avatar		string	Image avatar.
userlink	userlink		string	Lien vers le profil utilisateur.
httplink	httplink		string	Lien HTTP vers le profil utilisateur.
phone	phone		string	Numéro de téléphone.
mobile	mobile		string	Numéro de téléphone mobile.
department	department		string	Service de l’utilisateur.
Activer	enable		string	Activez l’intégration de Contract Express.
adminnote	adminnote		string	Notes administratives relatives au site.
startdate	startdate		string	Date de début de l’opération du site.
enddate	enddate		string	Date de fin de l’opération du site.
createddate	createddate		string	Date de création du site.
archiveddate	archiveddate		string	Date à laquelle le site a été archivé.
clientno	clientno		string	Numéro de client associé au site.
matterno	matterno		string	Numéro de la question associée au site.
page d’accueil	landingpage		string	URL de la page d’accueil du site.
link	link		string	Lien lié au site.
status	status		string	État actuel du site.
statusid	statusid		integer	Identificateur de l’état du site.
size	size		string	Taille du site.
notes de facturation	billingnotes		string	Remarques relatives à la facturation du site.
billingnextinvoicedate	billingnextinvoicedate		string	Date de la facture suivante pour le site.
billinglastinvoicedate	billinglastinvoicedate		string	Date de la dernière facture du site.
filepagecount	filepagecount		string	Nombre total de fichiers sur le site.
maxpagecount	maxpagecount		string	Nombre maximal de pages autorisés pour les fichiers sur le site.
sitehttplink	sitehttplink		string	Lien HTTP vers le site.
isSyncable	isSyncable		integer	Indique si le site est synchronisé.
enforceusergroups	enforceusergroups		string	Les groupes d’utilisateurs appliqués pour le site.
csvSiteCategory	csvSiteCategory		string	Catégorie du site au format CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nom du site dans la langue par défaut.
visible	visible		integer	Indique si le site est visible.
siteLogoName	siteLogoName		string	Nom du fichier logo du site.
siteLogoFileSize	siteLogoFileSize		integer	Taille du fichier du logo du site.
siteLogoHeight	siteLogoHeight		integer	Hauteur du logo du site.
siteLogoWidth	siteLogoWidth		integer	Largeur du logo du site.
siteStatus	siteStatus		integer	Code d’état du site.
applySiteTerms	applySiteTerms		integer	Indique si les termes du site sont appliqués.
siteTerm	siteTerm		string	Conditions appliquées au site.
termType	termType		integer	Type de termes appliqués au site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indique si les termes du site sont requis lors de la prochaine connexion.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indique si les termes du site par défaut sont activés.
advancedQAPermission	advancedQAPermission		integer	Niveau d’autorisation QA avancé pour le site.
estInterne	isInternal		integer	Indique si le site est interne.
Psm	psm		integer	Identificateur Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Étiquette d’affichage du site.
allowSiteAdministration	allowSiteAdministration		integer	Indiquant si l’administration du site est autorisée.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Pour activer la protection par mot de passe au niveau du site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Pour activer la protection du code secret au niveau du site.
code secretUsingAuthApp	passcodeUsingAuthApp		integer	Indique si l’authentification par code secret utilise une application d’authentification.
sitePassword	sitePassword		string	Mot de passe associé au site.
ipRestrictionEnable	ipRestrictionEnable		integer	Pour activer les restrictions IP pour l’accès au site.
availableIP	availableIP		string	Liste séparée par des virgules d’adresses IP autorisées à accéder au site.
highqDrive	highqDrive		integer	Indique si l’intégration de Lecteur HighQ est activée.
applySiteHomePage	applySiteHomePage		integer	Pour appliquer une page d’accueil personnalisée pour le site.
siteHomePage	siteHomePage		string	URL de la page d’accueil personnalisée du site.
siteHomePageType	siteHomePageType		integer	Type de la page d’accueil.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Pour définir la connexion suivante à la page d’accueil du site.
applyDisplayContent	applyDisplayContent		integer	Pour appliquer les paramètres d’affichage du contenu.
displayContent	displayContent		string	Contenu à afficher sur le site.
rssSecurity	rssSecurity		integer	Niveau de sécurité du flux RSS.
cryptéMot de passe	encryptedPassword		integer	Indique si le mot de passe du site est chiffré.
availableIPRangeCSV	availableIPRangeCSV		string	Liste séparée par des virgules des plages d’adresses IP autorisées à accéder au site.
siteModuleID	siteModuleID		integer	Identificateur du module de site.
icalSecurity	icalSecurity		integer	Niveau de sécurité du flux iCal.
defaultDisplayContent	defaultDisplayContent		string	Contenu par défaut à afficher sur le site.
defaultEmailAlert	defaultEmailAlert		integer	Pour activer les alertes par e-mail par défaut.
excelReportFooter	excelReportFooter		integer	Inclut un pied de page dans les rapports Excel.
excelReportFooterText	excelReportFooterText		string	Texte à afficher dans le pied de page des rapports Excel.
announcementMLJSON	announcementMLJSON		string	Annonces au format JSON pour le site.
templateType	templateType		integer	Type de modèle utilisé pour le site.
templateLicence	templateLicence		integer	Type de licence pour le modèle de site.
openChannelAppID	openChannelAppID		string	ID d’application pour l’intégration du canal ouvert.
itemid	itemid		integer	Identificateur de l’élément associé au site.
sitemetadatasheetid	sitemetadatasheetid		integer	ID de la feuille de métadonnées associée au site.
mysite	mysite		boolean	Indique s’il s’agit du site personnel de l’utilisateur.
lastaccesseddate	lastaccesseddate		string	Date et heure auxquelles le site a été consulté pour la dernière fois.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Onglet métadonnées par défaut pour la visionneuse de site.
documentMetadataViewId	documentMetadataViewId		integer	métadonnées de document pour l’identificateur d’affichage.
folderMetadataViewId	folderMetadataViewId		integer	métadonnées de dossier pour l’identificateur d’affichage.
docSort	docSort		integer	Ordre de tri des documents.
folderSort	folderSort		integer	Ordre de tri des dossiers.
defaultFolderRenderView	defaultFolderRenderView		integer	Détermine le mode d’affichage par défaut pour les dossiers.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Emplacement par défaut des pièces jointes de tâche.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Identificateur unique du dossier désigné comme emplacement par défaut pour les pièces jointes de tâche.
favori	favourite		string	statut favori.
enabledocumentredaction	enabledocumentredaction		boolean	Spécifie si la rédaction de document est activée pour le site.
mentiongroups	mentiongroups		integer	Groupes mentionnés.
enablefilerelationships	enablefilerelationships		boolean	Indique si les relations de fichier sont activées.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Niveau d’autorisation requis pour gérer les relations de fichiers.

Retours

Corps: site

Ajouter un utilisateur

ID d’opération :: createUser

Résumé	Code ref (avant V4)	Code ref (V4)
L’adresse e-mail est requise	101	101
Adresse e-mail non valide	104	104
Le prénom est obligatoire	102	102
Le nombre maximal de caractères autorisés pour le prénom doit être compris entre 1 et 100	102	352
L’adresse e-mail du secrétaire/assistant n’est pas valide	104	353
L’état doit être actif ou inactif	116	116
Le service entré ne peut pas comporter plus de 256 caractères	N/A	354
L’attribut ifpartner entré n’est pas valide	N/A	355
L’attribut systemuser entré n’est pas valide	N/A	356
L’attribut usertypeid entré n’est pas valide	N/A	357
L’attribut langcode entré n’est pas valide	N/A	358
L’attribut sourcetype entré n’est pas valide. Les valeurs valides sont System, Active Directory ou System default.	N/A	359
Entrez le numéro de téléphone valide	N/A	360
Entrez un numéro de téléphone valide au format {countrycode} ${areacode}${number}.	N/A	361
Entrez un numéro mobile valide au format {countrycode}${number}.	N/A	362
Entrez un code de pays de téléphone de bureau valide	N/A	363
Le code de pays du téléphone de bureau peut avoir un maximum de 4 chiffres	N/A	364
Entrez un code de zone téléphonique de bureau valide	N/A	365
Le code de zone téléphonique du bureau peut avoir un maximum de 5 chiffres	N/A	366
Le numéro de téléphone du bureau doit comporter au maximum 15 chiffres	N/A	368
Entrer un code de pays de téléphone mobile valide	N/A	369
Le code de pays du téléphone mobile peut avoir un maximum de 4 chiffres	N/A	372
Entrez un numéro mobile valide	N/A	373
Le numéro de téléphone mobile doit comporter au maximum 20 chiffres	N/A	374
Le domaine n’existe pas	105	105
L’e-mail existe déjà dans le système	111	111
Mentionner l’organisation en cas de domaine auto-inscrit	187	187
Mentionner l’organisation en cas de domaine exceptionnel	115	115
L’ID d’organisation n’est pas au format approprié	112	112
L’organisation n’existe pas	01:23:06 AM	01:23:06 AM
Le domaine existe dans d’autres organisations	114	114
L’ID d’adresse entré n’est pas valide	N/A	308
Nom du lien social introuvable dans le système.	N/A	375
Le nom du lien social est requis	N/A	376
La valeur du lien social est requise	N/A	377
Les caractères maximum pour la valeur de lien social doivent être compris entre 1 et 500	N/A	378
Entrez le nom du lien personnalisé	N/A	379
Valeur de lien personnalisée requise	N/A	380
Les caractères maximal pour le nom de lien personnalisé doivent être compris entre 1 et 500	N/A	381
Les caractères maximal pour la valeur de lien personnalisée doivent être compris entre 1 et 500	N/A	382
Nom du lien de message requis	N/A	383
Nom du lien de message introuvable dans le système	N/A	384
Valeur de lien de message requise	N/A	385
Les caractères maximal pour la valeur du lien de message doivent être compris entre 1 et 500	N/A	386
Le lien social est désactivé	N/A	408
Le lien de message est désactivé	N/A	409
Le lien personnalisé est désactivé	N/A	410

Ticket JIRA : https://dev.highq.com/jira/browse/COL-65685

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	version de l’API
index	index		integer	Index unique pour l’utilisateur.
userid	userid		integer	Identificateur unique de l’utilisateur.
prénom	firstname		string	Prénom de l’utilisateur.
nom de famille	lastname		string	Nom de l’utilisateur.
practicegroup	practicegroup		string	Groupe pratique auquel appartient l’utilisateur.
langcode	langcode		string	Code de langue de l’utilisateur.
localeID	localeID		string	ID de paramètres régionaux de l’utilisateur.
publicprofile	publicprofile		string	Profil public de l’utilisateur.
pwpid	pwpid		string	ID PWP de l’utilisateur.
usertypeid	usertypeid		string	ID de type utilisateur.
systemuser	systemuser		string	Indicateur utilisateur système.
Messagerie électronique	email		string	Email’adresse de l’utilisateur.
phone	phone		string	Numéro de téléphone de l’utilisateur.
mobile	mobile		string	Numéro mobile de l’utilisateur.
department	department		string	Service de l’utilisateur.
Org	org		string	Organisation à laquelle appartient l’utilisateur.
addressline1	addressline1		string	Première ligne de l’adresse.
addressline2	addressline2		string	Deuxième ligne de l’adresse.
addressline3	addressline3		string	Troisième ligne de l’adresse.
city	city		string	Ville de l’adresse.
état	state		string	État de l’adresse.
country	country		string	Pays de l’adresse.
Cp	postcode		string	Code postal de l’adresse.
addressid	addressid		string	Identificateur unique de l’adresse.
addressline1	addressline1		string	Première ligne de l’adresse.
addressline2	addressline2		string	Deuxième ligne de l’adresse.
addressline3	addressline3		string	Troisième ligne de l’adresse.
city	city		string	Ville de l’adresse.
état	state		string	État de l’adresse.
country	country		string	Pays de l’adresse.
Cp	postCode		string	Code postal de l’adresse.
knownas	knownas		string	Autre nom ou surnom de l’adresse.
expérience	experience		array of string
pièce d'identité	id		string	ID de lien
nom	name		string	Nom du lien.
value	value		string	Valeur du lien.
pièce d'identité	id		string	ID de lien
nom	name		string	Nom du lien.
value	value		string	Valeur du lien.
pièce d'identité	id		string	ID de lien
nom	name		string	Nom du lien.
value	value		string	Valeur du lien.
img	img		string
reportsto	reportsto		string
metadataname	metadataname		array of string
metadatavalue	metadatavalue		array of string
group	group		array of string
externalid	externalid		string	ID externe de l’utilisateur.
jobtitle	jobtitle		string	Titre du travail de l’utilisateur.
secretaryname	secretaryname		string	Nom du secrétaire de l’utilisateur.
secretarymail	secretarymail		string	E-mail du secrétaire de l’utilisateur.
Spécialités	specialities		string	Spécialités de l’utilisateur.
title	title		string	Titre de l’utilisateur.
goby	goesby		string	nom préféré de l’utilisateur.
suffixe	suffix		string	Suffixe du nom de l’utilisateur.
atomlink	atomlink		string	Lien Atom associé à l’utilisateur.
bio	bio		string	Biographie de l’utilisateur.
dateOfBirth	dateOfBirth		string	Date de naissance de l’utilisateur.
link	link		string	Lien associé à l’utilisateur.
status	status		string	État de l’utilisateur.
statuscode	statuscode		string	Code d’état de l’utilisateur.
Message	message		string	Message associé à l’utilisateur.
sourcetype	sourcetype		string	Type source de l’utilisateur.
orgid	orgid		string	ID de l’organisation.
ifpartner	ifpartner		string	Indicateur de partenaire.
emaildomain	emaildomain		string	Domaine de messagerie de l’utilisateur.
invitationsent	invitationsent		string	Indicateur d’invitation envoyé.
Créépar	createdby		string	Utilisateur qui a créé l’enregistrement.
createddate	createddate		string	Date de création de l’enregistrement.
modifié par	modifiedby		string	Utilisateur qui a modifié l’enregistrement.
modifieddate	modifieddate		string	Date de modification de l’enregistrement.
lastlogindate	lastlogindate		string	Date de la dernière connexion.
invalidlogins	invalidlogins		string	Nombre de tentatives de connexion non valides.
publicwebsiteprofileid	publicwebsiteprofileid		string	ID de profil du site web public.
resetpassworddate	resetpassworddate		string	Date de réinitialisation du mot de passe.
avatar	avatar		string	URL de l’image avatar.
nombre suivant	followingcount		integer	Nombre d’utilisateurs suivis.
followercount	followercount		integer	Nombre d’abonnés.
suivant	following		boolean	Indicateur suivant.
role	role		string	Rôle de l’utilisateur.
isbasicuser	isbasicuser		string	Indicateur utilisateur de base.
encryptedUserId	encryptedUserId		string	ID d’utilisateur chiffré.
autoinscrire	selfregistered		integer	Indicateur auto-inscrit.
registeredWith2FA	registeredWith2FA		string	Indicateur d’inscription d’authentification à deux facteurs.
estInterne	isInternal		integer	Indicateur utilisateur interne.
orgName	orgName		string	Nom de l’organisation.

Retours

Corps: IntegrationUserDBO

Archiver l’utilisateur

ID d’opération :: deleteUser

Cet appel d’API est utilisé pour archiver un utilisateur au sein du système.

Codes d’erreur

Résumé	Code ref (avant V4)	Code ref (V4)
Les utilisateurs suivants n’existent pas dans le système	110	110
Un ID d’utilisateur est requis	109	109
L’ID utilisateur n’est pas au format approprié	113	113
La longueur de l’ID de l’utilisateur ne peut pas dépasser 50 caractères	N/A	304

Ticket JIRA : https://dev.highq.com/jira/browse/COL-67441

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	version de l’API
Identifiant	userid	True	string	identifiant

Charger un fichier

ID d’opération :: insertDocument

Cet appel d’API charge un fichier dans un dossier spécifié sur la plateforme HighQ Collaborate. Il prend en charge les chargements segmentés lorsque l’en-tête Content-Range est fourni.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API utilisée.
Fichier à charger	file	True	file	Spécifie le fichier à charger.
ID de répertoire parent	parentfolderid	True	string	Spécifie l’ID unique du dossier parent dans lequel le fichier sera chargé.
Remplacer l’indicateur dupliqué	overrideduplicate		boolean	Indique si les chargements de fichiers en double doivent être remplacés.
Nom du document	filename	True	string	Spécifie le nom du document.
Version Note	versionnote		string	Fournit une note décrivant la version du fichier.
Clé d’opération progressive	progressiveoperkey		string	Spécifie la clé utilisée pour les opérations progressives pendant le chargement du fichier.
Nom de la base de données DMS	dmsdatabasename		string	Spécifie le nom de la base de données du système de gestion des documents.
Date de modification de DMS	dmseditdate		string	Spécifie la date de modification enregistrée dans le système de gestion des documents.
ID de dossier parent DMS	dmsparentfolderid		string	Spécifie l’ID unique du dossier parent dans le système de gestion des documents.
DMS Document ID	dmsdocid		string	Spécifie l’ID unique du document dans le système de gestion des documents.
DMS Document Version	dmsversion		string	Spécifie la version du document enregistrée dans le système de gestion des documents.
Détails de la notification	notification		string	Fournit des détails sur les notifications à envoyer lors du chargement du fichier.
ID de lot	batchid		string	Spécifie l’ID unique de l’opération de traitement par lots.
ID de dossier racine	rootfolderid		string	Spécifie l’ID unique du dossier racine.

Créer un dossier

ID d’opération :: addFolder

Cette API crée un dossier dans le site spécifié. Il vous permet de fournir les détails du dossier et de s’assurer que le dossier est créé sous le dossier parent donné.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API.
Identificateur de lot	batchid		string	Identificateur unique pour l’opération de traitement par lots.
ID de dossier racine	rootfolderid		string	Identificateur unique du dossier racine.
ID de répertoire parent	parentfolderid	True	string	Identificateur unique du dossier parent où le nouveau dossier sera créé.
Autoriser le dossier dupliqué	allowduplicatefolder		boolean	Indique si les dossiers en double sont autorisés dans le dossier parent spécifié.
nom	name	True	string	Nom du dossier.
descriptif	description		string	Description du dossier.
accessInherited	accessInherited		integer	Indique si l’accès au dossier est hérité.
batchID	batchID		string	Identificateur de lot de l’opération.
dmsfolderid	dmsfolderid		string	Identificateur du dossier DMS.
dmsParentFolderID	dmsParentFolderID		string	Identificateur du dossier parent DMS.
dmscreateddate	dmscreateddate		date-time	Date de création du dossier DMS.
dmsmodifiedBy	dmsmodifiedBy		string	Utilisateur qui a modifié le dossier DMS pour la dernière fois.
dmsdatabasename	dmsdatabasename		string	Nom de la base de données DMS.
dmslink	dmslink		boolean	Indique si un lien DMS est disponible.
dmslinkby	dmslinkby		string	Utilisateur qui a lié le dossier DMS.
emailmetadata	emailmetadata		string	Métadonnées d’e-mail associées au dossier.

Retours

Corps: FolderDBOV1

Déplacer des documents

ID d’opération :: moveDocuments

Cette API déplace plusieurs fichiers d’un dossier vers un autre au sein du même site.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API.
ID de dossier cible	targetfolder	True	string	Identificateur unique du dossier cible où les fichiers seront déplacés.
fileidCSV	fileidCSV		string	Liste séparée par des virgules des ID de fichier à déplacer.

Mettre à jour le groupe de sites

ID d’opération :: updateSiteGroup

Cette méthode d’API met à jour le nom d’un groupe existant dans un site.
Cette API a été étendue pour mettre à jour le nom d’un groupe d’utilisateurs de base existant dans un site.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	version
ID du site	siteid	True	string	ID du site.
Version de l’API	groupid	True	string	`The ID of the site group.`
nom	name		string
pièce d'identité	id		integer
copypermissionsfrom	copypermissionsfrom		string
Message	message		string
typeID	typeID		integer
type	type		string
numberofusers	numberofusers		string
créé	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
descriptif	description		string
basicusergroup	basicusergroup		integer

Retours

Corps: sitegroup

Mettre à jour le site

ID d’opération :: updateSite

Utilisez ce point de terminaison d’API pour mettre à jour les détails d’un site existant. L’API prend en charge les mêmes champs que ceux utilisés dans l’API Créer un site.

Version 18 : une catégorie (usage du site) est requise. Si l’objectif du site est masqué, un message s’affiche ; sinon, les objectifs du site masqué ne sont pas ajoutés au site.

Version 18 : le propriétaire du site peut ajouter d’autres utilisateurs au site.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API demandée	version	True	string	version de l’API
Identificateur unique du site	siteid	True	string	ID du site
pièce d'identité	id		integer	Identificateur de site.
nom_site	sitename		string	Le nom du site.
role	role		string	Rôle du site.
sitedescription	sitedescription		string	Description du site.
enabledmodules	enabledmodules		string	Liste des modules activés pour le site.
sitefolderID	sitefolderID		string	Identificateur du dossier du site.
sitefolderpermission	sitefolderpermission		string	Niveau d’autorisation pour le dossier du site.
Activer	enable		string	Activer l’état de HomeDBO.
Activer	enable		string	Activer l’état de ActivityDBO.
microblog	microblog		string	Contenu de microblog associé à ActivityDBO.
docid	docid		string	ID de document.
blogTitle	blogTitle		string	Titre du billet de blog.
blogContent	blogContent		string	Contenu du billet de blog.
showComment	showComment		integer	affichez le commentaire.
tagList	tagList		array of string	Liste des balises associées au blog.
status	status		integer	état du billet de blog.
siteID	siteID		integer	Identificateur du site associé.
author	author		string	Auteur du blog.
categoryList	categoryList		array of string	Catégories affectées au billet de blog.
notificationTypeID	notificationTypeID		integer	Identificateur du type de notification.
Message	message		string	Contenu du message lié au blog.
messageCode	messageCode		integer	Code associé au message.
identifiant externe	externalID		string	Identificateur externe lié au blog.
publishDate	publishDate		string	Date de publication du blog.
processtype	processtype		string	Type de processus associé au blog.
Activer	enable		string	Activer l’état pour BlogDBO.
wikiid	wikiid		integer	Identificateur unique pour le wiki.
currentversionid	currentversionid		integer	Identificateur de la version actuelle du wiki
parentwikiid	parentwikiid		integer	Identificateur du wiki parent.
wikititle	wikititle		string	Titre du wiki.
wikicontent	wikicontent		string	Contenu du wiki.
showcomment	showcomment		integer	Indiquant si les commentaires sont activés.
createddate	createddate		string	Date de création du wiki.
modifieddate	modifieddate		string	Date de dernière modification du wiki.
taglist	taglist		string	Liste séparée par des virgules des balises associées au wiki.
wikipath	wikipath		string	Chemin d’accès au wiki.
wikidraftid	wikidraftid		integer	Identificateur de la version brouillon du wiki.
brouillon	drafttype		string	Type de brouillon associé au wiki.
status	status		integer	État actuel du wiki.
wikiversionid	wikiversionid		integer	Identificateur de version du wiki.
index	index		string	Index ou identificateur de la tâche.
parenttaskid	parenttaskid		integer	Identificateur de la tâche parente.
taskid	taskid		integer	Identificateur unique de la tâche.
title	title		string	Titre de la tâche.
descriptif	description		string	Description détaillée de la tâche.
duedate	duedate		string	Date d’échéance de la fin de la tâche.
startdate	startdate		string	Date de début de la tâche.
mattermaptaskid	mattermaptaskid		string	Identificateur lié à la tâche de mappage de matière.
type	type		string	Type ou catégorie de la tâche.
dependenton	dependenton		string	Les tâches dont dépend cette tâche.
daysfromdependent	daysfromdependent		string	Nombre de jours à partir de la tâche dépendante.
ignoreweekend	ignoreweekend		integer	Indique si les week-ends sont ignorés dans la planification.
duration	duration		integer	Durée d’exécution de la tâche.
resource	resource		string	Ressources affectées à la tâche.
eventTitle	eventTitle		string	Titre de l’événement.
eventContent	eventContent		string	Contenu de l’événement.
showComment	showComment		integer	Indiquant si les commentaires sont activés pour l’événement.
tagList	tagList		array of string	Liste des balises associées à l’événement.
status	status		integer	État actuel de l’événement.
siteID	siteID		integer	Identificateur du site.
contacter	contact		string	Informations de contact pour l’événement.
categoryList	categoryList		array of string	Catégories sous lesquelles l’événement est répertorié.
notificationTypeID	notificationTypeID		integer	Type de notification lié à l’événement.
Message	message		string	Message de l’événement.
messageCode	messageCode		integer	Code de message de l’événement.
identifiant externe	externalID		string	Identificateur externe.
date de début	startDate		string	Date de début de l’événement.
date de fin	endDate		string	Date de fin de l’événement.
startTime	startTime		string	Heure de début de l’événement.
endTime	endTime		string	Heure de fin de l’événement.
location	location		string	Emplacement de l’événement.
author	author		string	Auteur de l’événement.
processtype	processtype		string	Heure de processus de l’événement.
Activer	enable		string	Activez l’événement.
pièce d'identité	id		integer	Identificateur unique de la feuille iSheet.
title	title		string	Titre de la feuille iSheet.
descriptif	description		string	Description de la feuille isheet.
status	status		string	État de la feuille isheet.
accesstype	accesstype		string	Type d’accès de la feuille isheet.
type	type		string	Type de la feuille isheet.
viewlink	viewlink		string	Lien pour afficher la feuille iSheet.
allowsections	allowsections		string	Indique si les sections sont autorisées.
allowlookup	allowlookup		string	Indique si les champs de recherche sont activés.
displayisheet	displayisheet		string	Options d’affichage de la feuille iSheet.
searchasdefaultview	searchasdefaultview		string	Indique si la recherche est en mode par défaut.
enableversion	enableversion		string	Indicateur activé pour le contrôle de version.
enablesheetalerter	enablesheetalerter		string	Indicateur pour activer les alertes de feuille.
alertercondition	alertercondition		string	Conditions pour déclencher des alertes.
overrideitemmodifieddate	overrideitemmodifieddate		string	Remplacer l’indicateur de date de modification.
enablebulkinsertupdate	enablebulkinsertupdate		string	Activez l’insertion/mise à jour en bloc.
fielddescriptions	fielddescriptions		string	Descriptions des champs de l’iSheet.
enablerowlocking	enablerowlocking		string	Activer le verrouillage au niveau des lignes.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Tronquer l’indicateur de texte multiligne.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limite de caractères pour la troncation multiligne.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Autorisez la réutilisation des valeurs de liste de choix.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Autorisez la réutilisation des valeurs de liste de score.
allowIsheetComments	allowIsheetComments		string	Autoriser les commentaires dans iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limite des enregistrements autorisés à partager.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Limite de partage d’enregistrements activée.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Activez le partage de formulaires pour l’ajout d’enregistrements.
recordcount	recordcount		string	Nombre d’enregistrements actuel.
sheettypeid	sheettypeid		integer	ID de type de la feuille iSheet
Activer	enable		string	Activer la fonctionnalité DQ.
userid	userid		integer	Identifiant utilisateur.
Messagerie électronique	email		string	adresse courriel.
httpavatar	httpavatar		string	URL HTTP de l’avatar.
avatar	avatar		string	Image avatar.
userlink	userlink		string	Lien vers le profil utilisateur.
httplink	httplink		string	Lien HTTP vers le profil utilisateur.
phone	phone		string	Numéro de téléphone.
mobile	mobile		string	Numéro de téléphone mobile.
department	department		string	Service de l’utilisateur.
Activer	enable		string	Activez l’intégration de Contract Express.
adminnote	adminnote		string	Notes administratives relatives au site.
startdate	startdate		string	Date de début de l’opération du site.
enddate	enddate		string	Date de fin de l’opération du site.
createddate	createddate		string	Date de création du site.
archiveddate	archiveddate		string	Date à laquelle le site a été archivé.
clientno	clientno		string	Numéro de client associé au site.
matterno	matterno		string	Numéro de la question associée au site.
page d’accueil	landingpage		string	URL de la page d’accueil du site.
link	link		string	Lien lié au site.
status	status		string	État actuel du site.
statusid	statusid		integer	Identificateur de l’état du site.
size	size		string	Taille du site.
notes de facturation	billingnotes		string	Remarques relatives à la facturation du site.
billingnextinvoicedate	billingnextinvoicedate		string	Date de la facture suivante pour le site.
billinglastinvoicedate	billinglastinvoicedate		string	Date de la dernière facture du site.
filepagecount	filepagecount		string	Nombre total de fichiers sur le site.
maxpagecount	maxpagecount		string	Nombre maximal de pages autorisés pour les fichiers sur le site.
sitehttplink	sitehttplink		string	Lien HTTP vers le site.
isSyncable	isSyncable		integer	Indique si le site est synchronisé.
enforceusergroups	enforceusergroups		string	Les groupes d’utilisateurs appliqués pour le site.
csvSiteCategory	csvSiteCategory		string	Catégorie du site au format CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nom du site dans la langue par défaut.
visible	visible		integer	Indique si le site est visible.
siteLogoName	siteLogoName		string	Nom du fichier logo du site.
siteLogoFileSize	siteLogoFileSize		integer	Taille du fichier du logo du site.
siteLogoHeight	siteLogoHeight		integer	Hauteur du logo du site.
siteLogoWidth	siteLogoWidth		integer	Largeur du logo du site.
siteStatus	siteStatus		integer	Code d’état du site.
applySiteTerms	applySiteTerms		integer	Indique si les termes du site sont appliqués.
siteTerm	siteTerm		string	Conditions appliquées au site.
termType	termType		integer	Type de termes appliqués au site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indique si les termes du site sont requis lors de la prochaine connexion.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indique si les termes du site par défaut sont activés.
advancedQAPermission	advancedQAPermission		integer	Niveau d’autorisation QA avancé pour le site.
estInterne	isInternal		integer	Indique si le site est interne.
Psm	psm		integer	Identificateur Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Étiquette d’affichage du site.
allowSiteAdministration	allowSiteAdministration		integer	Indiquant si l’administration du site est autorisée.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Pour activer la protection par mot de passe au niveau du site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Pour activer la protection du code secret au niveau du site.
code secretUsingAuthApp	passcodeUsingAuthApp		integer	Indique si l’authentification par code secret utilise une application d’authentification.
sitePassword	sitePassword		string	Mot de passe associé au site.
ipRestrictionEnable	ipRestrictionEnable		integer	Pour activer les restrictions IP pour l’accès au site.
availableIP	availableIP		string	Liste séparée par des virgules d’adresses IP autorisées à accéder au site.
highqDrive	highqDrive		integer	Indique si l’intégration de Lecteur HighQ est activée.
applySiteHomePage	applySiteHomePage		integer	Pour appliquer une page d’accueil personnalisée pour le site.
siteHomePage	siteHomePage		string	URL de la page d’accueil personnalisée du site.
siteHomePageType	siteHomePageType		integer	Type de la page d’accueil.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Pour définir la connexion suivante à la page d’accueil du site.
applyDisplayContent	applyDisplayContent		integer	Pour appliquer les paramètres d’affichage du contenu.
displayContent	displayContent		string	Contenu à afficher sur le site.
rssSecurity	rssSecurity		integer	Niveau de sécurité du flux RSS.
cryptéMot de passe	encryptedPassword		integer	Indique si le mot de passe du site est chiffré.
availableIPRangeCSV	availableIPRangeCSV		string	Liste séparée par des virgules des plages d’adresses IP autorisées à accéder au site.
siteModuleID	siteModuleID		integer	Identificateur du module de site.
icalSecurity	icalSecurity		integer	Niveau de sécurité du flux iCal.
defaultDisplayContent	defaultDisplayContent		string	Contenu par défaut à afficher sur le site.
defaultEmailAlert	defaultEmailAlert		integer	Pour activer les alertes par e-mail par défaut.
excelReportFooter	excelReportFooter		integer	Inclut un pied de page dans les rapports Excel.
excelReportFooterText	excelReportFooterText		string	Texte à afficher dans le pied de page des rapports Excel.
announcementMLJSON	announcementMLJSON		string	Annonces au format JSON pour le site.
templateType	templateType		integer	Type de modèle utilisé pour le site.
templateLicence	templateLicence		integer	Type de licence pour le modèle de site.
openChannelAppID	openChannelAppID		string	ID d’application pour l’intégration du canal ouvert.
itemid	itemid		integer	Identificateur de l’élément associé au site.
sitemetadatasheetid	sitemetadatasheetid		integer	ID de la feuille de métadonnées associée au site.
mysite	mysite		boolean	Indique s’il s’agit du site personnel de l’utilisateur.
lastaccesseddate	lastaccesseddate		string	Date et heure auxquelles le site a été consulté pour la dernière fois.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Onglet métadonnées par défaut pour la visionneuse de site.
documentMetadataViewId	documentMetadataViewId		integer	métadonnées de document pour l’identificateur d’affichage.
folderMetadataViewId	folderMetadataViewId		integer	métadonnées de dossier pour l’identificateur d’affichage.
docSort	docSort		integer	Ordre de tri des documents.
folderSort	folderSort		integer	Ordre de tri des dossiers.
defaultFolderRenderView	defaultFolderRenderView		integer	Détermine le mode d’affichage par défaut pour les dossiers.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Emplacement par défaut des pièces jointes de tâche.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Identificateur unique du dossier désigné comme emplacement par défaut pour les pièces jointes de tâche.
favori	favourite		string	statut favori.
enabledocumentredaction	enabledocumentredaction		boolean	Spécifie si la rédaction de document est activée pour le site.
mentiongroups	mentiongroups		integer	Groupes mentionnés.
enablefilerelationships	enablefilerelationships		boolean	Indique si les relations de fichier sont activées.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Niveau d’autorisation requis pour gérer les relations de fichiers.

Obtenir des informations sur les dossiers

ID d’opération :: getFolderInfo

La méthode fournit des détails de dossier de l’ID de dossier donné.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	version de l’API
ID du dossier	folderid	True	string	folderID
Informations d’état	statusinfo		boolean	Le paramètre statusinfo vous permet d’accéder à des informations supplémentaires sur le dossier. Les informations disponibles incluent l’état partagé, l’état favori pour l’utilisateur connecté

Retours

Corps: FolderDBOV2

Pour créer l’élément iSheet

ID d’opération :: insertISheetItems

Cet appel d’API est utilisé pour insérer un élément iSheet. Plusieurs feuilles iSheet peuvent être prises en charge.

Pour obtenir l’état d’un élément iSheet basé sur une clé progressive, appelez API POST /api/3/progressivekeystatus/{progressive_key}

par exemple POST /api/{version}/progressivekeystatus/{progressive_key}

Nom	Type	Descriptif
progressive_key	Chaîne	Clé pour vérifier l’état de votre action.

Réponse


              
              <progressivekeyresponse>

               Éléments \t<>

                \t\t<item>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\<>status SUCCESS</status>

                 \t\t\t<statuscode>200</statuscode>

                 \t\t\t<message>Record ajouté avec succès</message>

                \t\t</item>

                \t\t<item>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\<>status SUCCESS</status>

                 \t\t\t<statuscode>200</statuscode>

                 \t\t\t<message>Record ajouté avec succès</message>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Version de l’API
Identificateur iSheet	isheetid	True	integer	ID de la feuille iSheet
Identificateur d’affichage feuille	sheetviewid		integer	ID de l’affichage iSheet (facultatif)
pièce d'identité	id		integer	Identificateur de feuille Isheet.
title	title		string	Titre de la feuille.
descriptif	description		string	Description de la feuille.
status	status		string	État de la feuille.
accesstype	accesstype		string	Type d’accès de la feuille.
type	type		string	Type de la feuille.
viewlink	viewlink		string	Lien d’URL pour afficher la feuille.
allowsections	allowsections		string	Indique si les sections sont autorisées.
allowlookup	allowlookup		string	Indique si la recherche est autorisée.
displayisheet	displayisheet		string	Afficher la feuille isheet.
searchasdefaultview	searchasdefaultview		string	Définit la recherche en tant qu’affichage par défaut.
enableversion	enableversion		string	Activer la version.
enablesheetalerter	enablesheetalerter		string	Active l’alerte de feuille.
alertercondition	alertercondition		string	Condition pour déclencher des alertes.
overrideitemmodifieddate	overrideitemmodifieddate		string	Au-dessus de la date de modification de l’élément.
enablebulkinsertupdate	enablebulkinsertupdate		string	Autoriser la mise à jour d’insertion en bloc.
fielddescriptions	fielddescriptions		string	description des champs.
enablerowlocking	enablerowlocking		string	Active le verrouillage de ligne.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Active la troncation de limite de caractères pour le texte multiligne.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	définit la limite de caractères pour la troncation.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permet la réutilisation des valeurs de liste de choix.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permet la réutilisation des valeurs de liste de score.
allowIsheetComments	allowIsheetComments		string	Autorise les commentaires sur la feuille.
shareRecordsLimit	shareRecordsLimit		integer	Limite des enregistrements partagés.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Activez la limite d’enregistrement de partage.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Active le partage d’un formulaire d’enregistrement.
allowViewBaseRendering	allowViewBaseRendering		string	Autorise le rendu de base des vues.
N°	column		object
recordcount	recordcount		string	Nombre total d’enregistrements.
viewId	viewId		integer	Identificateur unique de la vue.
siteId	siteId		integer	Identificateur du site associé.
Nom du site	siteName		string	Nom du site.
sheetName	sheetName		string	Nom de la feuille.
viewName	viewName		string	Nom de la vue.
sheetId	sheetId		integer	Identificateur de la feuille.
Séquence	sequence		string	Numéro de séquence de la colonne d’en-tête.
columnValue	columnValue		string	Valeur de la colonne d’en-tête.
columnTypeId	columnTypeId		string	Identificateur du type de colonne.
columnId	columnId		string	Identificateur unique de la colonne.
columnTypeAlias	columnTypeAlias		string	Nom d’alias pour le type de colonne.
itemsequence	itemsequence		string	Numéro de séquence de l’élément.
itemid	itemid		string	Identificateur unique de l’élément.
externalid	externalid		string	Identificateur externe associé à l’élément.
columnid	columnid		integer	Identificateur unique pour la colonne
nom	name		string	Nom de la colonne
type	type		integer	Type de données de la colonne.
systemgeneratedtype	systemgeneratedtype		string	Informations de type générées par le système.
section	section		integer	Numéro de section où se trouve la colonne.
descriptif	description		string	Description détaillée de la colonne.
addtodefaultview	addtodefaultview		string	Indique si la colonne est ajoutée à la vue par défaut.
columnconditionstate	columnconditionstate		string	État de la condition de la colonne.
rowid	rowid		integer	Identificateur de la ligne.
columnid	columnid		integer	Identificateur de la colonne.
operatorid	operatorid		integer	Identificateur de l’opérateur.
oprand	oprand		string	Valeur d’opérande pour le filtre.
logicaltype	logicaltype		string	Type logique du filtre.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	ID du type de valeur de filtre de feuille.
displaytype	displaytype		string	Type d’affichage du filtre.
sourceColumnId	sourceColumnId		integer	ID de colonne source du filtre.
scoreConditionTypeid	scoreConditionTypeid		integer	ID du type de condition de score.
defaultvalue	defaultvalue		string	Valeur par défaut pour la colonne.
columnwidth	columnwidth		string	Largeur de la colonne.
sheetname	sheetname		string	Nom de la feuille associée.
nom_site	sitename		string	Nom du site.
obligatoire	mandatory		string	Indique si la colonne est obligatoire.
allowsearch	allowsearch		string	Spécifie si la recherche est autorisée.
maxchars	maxchars		integer	Nombre maximal de caractères.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Autorise le champ d’une autre feuille.
allowrichhtmltext	allowrichhtmltext		string	Spécifie si du texte HTML enrichi est autorisé.
numberoflines	numberoflines		integer	Nombre de lignes dans la colonne.
displaymethod	displaymethod		string	Méthode utilisée pour afficher la colonne.
includeotheroption	includeotheroption		string	Inclut une option « Autre ».
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Spécifie le type de sélection dans la recherche.
pièce d'identité	id		string	Identificateur unique pour le choix. »
label	label		string	Étiquette du choix.
score	score		string	Score associé au choix.
color	color		string	Code de couleur pour le choix.
imageid	imageid		integer	ID de l’image associée.
includeinalertpreferences	includeinalertpreferences		string	Inclut les préférences d’alerte.
min	min		string	Valeur minimale pour la colonne.
max	max		string	Valeur maximale de la colonne.
Décimales	decimalplaces		integer	Nombre de décimales.
showthousandseparators	showthousandseparators		string	Affiche des milliers de séparateurs.
showaspercentage	showaspercentage		string	Affiche la valeur sous forme de pourcentage.
formattype	formattype		string	Spécifie le type de format de la colonne.
dateformat	dateformat		string	Définit le format de date de la colonne.
defaultdateandtime	defaultdateandtime		string	Définit la valeur de date et d’heure par défaut pour la colonne.
sheetlookup	sheetlookup		string	Indique si la colonne est une recherche vers une autre feuille.
fielddisplay	fielddisplay		string	Détermine la façon dont le champ est affiché.
allowmultipleusers	allowmultipleusers		string	Spécifie si plusieurs utilisateurs peuvent accéder au champ.
methodtype	methodtype		string	Définit le type de méthode pour la colonne.
sheetids	sheetids		string	Répertorie les ID des feuilles associées à la colonne.
allowuserstorenamelinks	allowuserstorenamelinks		string	Indique si les utilisateurs peuvent renommer des liens dans la colonne.
sheetid	sheetid		integer	Spécifie l’ID de la feuille.
columnids	columnids		string	Répertorie les ID des colonnes.
viewid	viewid		integer	Spécifie l’ID de la vue.
allowmultiplevalues	allowmultiplevalues		string	Indique si plusieurs valeurs sont autorisées dans la colonne.
restrictdelete	restrictdelete		string	Spécifie si la suppression est restreinte pour la colonne.
displaycolumnnameprefix	displaycolumnnameprefix		string	Définit le préfixe de l’affichage du nom de colonne.
linkname	linkname		string	Définit le nom du lien associé à la colonne.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Spécifie si les week-ends sont exclus du comptage.
currentsheetcolumnid	currentsheetcolumnid		integer	ID de la colonne de feuille active.
targetsheetcolumnid	targetsheetcolumnid		integer	ID de la colonne de feuille cible.
formule	formula		string	Spécifie la formule appliquée à la colonne.
startvalue	startvalue		integer	Définit la valeur de départ de la colonne.
prefix	prefix		string	Définit le préfixe des valeurs de colonne.
Postfix	postfix		string	Définit le postfix pour les valeurs de colonne.
minlength	minlength		integer	Spécifie la longueur minimale des valeurs de colonne.
lookupglossarysheetid	lookupglossarysheetid		integer	Spécifie l’ID de la feuille de glossaire de recherche.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Spécifie l’ID d’affichage de la feuille de glossaire de recherche.
width	width		integer	Définit la largeur de la colonne.
otherscorevalue	otherscorevalue		string	Définit l’autre valeur de score pour la colonne.
importdatafromexternalsource	importdatafromexternalsource		string	Indique si les données sont importées à partir d’une source externe.
analysisengine	analysisengine		string	Spécifie le moteur d’analyse utilisé pour la colonne.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Spécifie l’ID de dossier personnalisé pour les pièces jointes.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Indique si le dossier de pièces jointes se trouve dans le site actuel.
singleLineEmailValidation	singleLineEmailValidation		string	Spécifie si la validation d’e-mail à ligne unique est appliquée.
Lecture seule	readonly		string	Indique si la colonne est en lecture seule.
virtualColumn	virtualColumn		integer	Spécifie si la colonne est virtuelle.
allowInlineEditing	allowInlineEditing		string	Indique si la modification inline est autorisée pour la colonne.
Séquence	sequence		string	Numéro de séquence de la colonne.
attributecolumnid	attributecolumnid		string	Identificateur de colonne d’attribut.
value	value		string	Valeur des données brutes.
date	date		string	date des données brutes.
time	time		string	Heure des données brutes.
linkdisplayname	linkdisplayname		string	Afficher le nom du lien.
linkdisplayurl	linkdisplayurl		string	Afficher le lien URL.
pièce d'identité	id		string	ID de recherche
Messagerie électronique	email		string	Adresse e-mail.
userlookuptype	userlookuptype		string	Type de recherche utilisateur.
folderid	folderid		string	ID de dossier.
docid	docid		string	ID de document.
fromdate	fromdate		string	À partir de la date.
todate	todate		string	À ce jour.
file	file		string	Contenu du fichier.
nom	name		string	Nom de fichier de la pièce jointe
order	order		string	Ordre de la pièce jointe.
pièce d'identité	id		integer	Identificateur unique de la pièce jointe.
extension	extension		string	Extension de fichier.
parentfolderid	parentfolderid		integer	ID du dossier parent.
filehttplink	filehttplink		string	Lien HTTP pour accéder au fichier.
chemin du dossier	folderpath		string	Chemin d’accès au dossier contenant le fichier.
folderhttplink	folderhttplink		string	Lien HTTP vers le dossier.
fichiersize	filesize		integer	Taille du fichier en octets.
redactionStatus	redactionStatus		boolean	Indique si le fichier est supprimé.
displayname	displayname		string	Nom complet de la pièce jointe.
siteid	siteid		integer	ID du site associé à la pièce jointe.
Identifiant d’enregistrement	recordid		string	ID d’enregistrement.
linkname	linkname		string	Nom du lien.
apilink	apilink		string	Lien d’API.
httplink	httplink		string	Lien HTTP.
colViewPosition	colViewPosition		integer	Position de la colonne dans la vue.
columntype	columntype		string	Type de la colonne.
date de création	createdDate		date-time	Date et heure de création de la colonne.
modifiedDate	modifiedDate		date-time	Date et heure de la dernière modification de la colonne.
injectReferenceColumn	injectReferenceColumn		integer	Référence à une colonne injectée
parentColumnID	parentColumnID		integer	Identificateur de la colonne parente.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	ID de colonne réutilisé à partir d’une feuille d’entrée.
choicelistid	choicelistid		integer	Identificateur de la liste de choix associée à la colonne.
alerteroption	alerteroption		string	Paramètre d’option d’alerte pour l’élément.
sheettypeid	sheettypeid		integer	Identificateur du type de feuille.
enableSmartForm	enableSmartForm		string	Active les fonctionnalités de formulaire intelligent.
allowDeletedItemsView	allowDeletedItemsView		string	Permet l’affichage des éléments supprimés.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Autorise toutes les colonnes dans les vues personnalisées.

Retours

Corps: ProgressiveKeyDBO

Récupérer des colonnes iSheet

ID d’opération :: getIsheetColumns

Cet appel d’API récupère les colonnes associées à la feuille iSheet spécifiée. Cette fonctionnalité est prise en charge dans l’API version 3 et ultérieure.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID iSheet	isheetid	True	integer	Spécifie l’ID unique de la feuille iSheet pour laquelle les colonnes sont requises.
Version de l’API	version	True	string	Spécifie la version de l’API utilisée.
ID d’affichage iSheet	sheetviewid		string	Spécifie l’ID de l’affichage iSheet. En cas d’omission, toutes les colonnes sont retournées.
Inclure les colonnes iSheet supprimées	onlyForDeletedIsheet		boolean	Indique s’il faut inclure des colonnes à partir d’une feuille iSheet supprimée. La valeur par défaut est false.

Retours

Corps: columns

Récupérer la liste des utilisateurs

ID d’opération :: getAllSystemUsers

Récupérer une liste d’utilisateurs Cette API récupère une liste d’utilisateurs à partir du système. Fonctionnalités clés ## - Récupérer les détails de l’utilisateur avec plusieurs options de filtrage - Prend en charge la pagination avec `limit` et `offset` - Nouveaux paramètres de requête et champs introduits dans les versions récentes - Réponse structurée avec les rôles d’utilisateur et les attributs ## Nouveaux paramètres de requête (Version-Specific) - Introduit dans V12 : - `systemAdminSearch`: Quand la `1`valeur est définie, retourne uniquement les utilisateurs avec le rôle Administrateur système. - Introduit dans V18 : : `userid`accepte les valeurs séparées par des virgules (CSV). Mises à jour du corps de la réponse ## - Nouveaux champs ajoutés : - `emaildomain`, `org`, `invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, , , `publicprofile`# `dateOfBirth` # # Format de modification (à partir de V11) - La `location` balise a été renommée pour `address` cohérence. - Exemple de réponse : `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Rôles d’utilisateur (introduits dans l’API V11+) - Exemple de réponse : `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limites et décalages - Comportement limite : - Valeur par défaut : `100` si aucune valeur n’est fournie. - Permet `-1` de retourner tous les enregistrements. - Si la valeur est inférieure `-1`à , la valeur par défaut est `100`. - Comportement de décalage : - Valeur par défaut : `0` si aucune valeur n’est fournie. - Si le décalage dépasse le nombre total d’enregistrements, la valeur par défaut est revenir à `0`. ## Nouveaux rôles introduits - V12 : `Basic User`, `Allow user to bypass XSS protection` - V14 : `Allow user to manage Contract Express system groups` ## Codes d’erreur | Résumé | Code ref (avant V4) | Code ref (V4) | |---------|----------------------|--------------| | | Entrée non valide pour l’état utilisateur (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | L’ID d’organisation n’est pas valide | N/A | 260 | | | Valeur non valide `neverinvited` (true/false) | N/A | 387 | | | Valeur non valide `neverlogin` (true/false) | N/A | 388 | | | Valeur non valide `groupids` | N/A | 214 | | | Valeur non valide `notingroup` (true/false) | N/A | 389 | | Non valide `ordertype` (pris en charge : nom, organisation, état, etc.) | N/A | 289 | | Non valide `orderby` (pris en charge : asc, desc) | N/A | 290 | | | Valeur non valide `offset` | 138 | 138 | | Valeur non valide `limit` | 137 | 137 | ## Remarques - À partir de V13, cette API est ouverte pour tous les utilisateurs (précédemment limités aux administrateurs système). - À partir de la version 18, le `userregistered2FA` champ indique si un utilisateur s’est inscrit pour 2FA. --- Cette description suit la mise en forme de schéma Swagger 2.0 et doit être placée dans le champ de description dans le schéma du connecteur personnalisé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Version de l’API.
État de l’utilisateur	status		string	Filtrez les utilisateurs par état : actif, archivé, inactif ou verrouillé.
Décalage de pagination	offset		string	Position de départ pour la pagination.
Limite des résultats	limit		string	Nombre d’éléments à retourner par requête.
ID d’organisation	orgid		string	Filtrez les utilisateurs par ID d’organisation.
Jamais invité les utilisateurs	neverinvited		string	Récupérez les utilisateurs qui n’ont jamais été invités.
Utilisateurs jamais connectés	neverlogin		string	Récupérez les utilisateurs qui n’ont jamais été connectés.
ID d’utilisateur	userid		string	Filtrez les utilisateurs en fonction de leurs ID d’utilisateur uniques.
ID de groupe	groupid		string	Filtrer les utilisateurs par ID de groupe.
Utilisateurs non dans les groupes	notingroup		string	Récupérez les utilisateurs qui ne sont pas dans un groupe.
Trier le type d’ordre	ordertype		string	Triez les utilisateurs par un champ spécifié, tel que le nom, l’organisation ou l’état.
Ordre de tri	orderby		string	Le tri entraîne l’ordre croissant ou décroissant.
ID externe	externalid		string	Filtrez les utilisateurs par ID externe.
Prénom	firstname		string	Filtrez les utilisateurs par prénom.
Nom de famille	lastname		string	Filtrez les utilisateurs par nom.
Adresse électronique	email		string	Filtrez les utilisateurs par adresse e-mail.
Recherche d’utilisateurs	search		string	Recherchez les utilisateurs par différents attributs, notamment le nom, l’e-mail et le titre du travail.
Filtre alphabétique	alphabets		string	Filtrez les utilisateurs dont le nom commence par une lettre spécifique.
Poste	jobtitle		string	Filtrez les utilisateurs par titre de travail.
Emplacement	locations		string	Filtrer les utilisateurs par ville.
Département	departments		string	Filtrez les utilisateurs par service.
Nom de l’organisation	organisations		string	Filtrez les utilisateurs par nom d’organisation.
Spécialités	specialities		string	Filtrez les utilisateurs par leurs spécialités.
Recherche d’administrateur système	systemAdminSearch		string	Récupérez les utilisateurs avec le rôle Administrateur système.

Retours

Corps: users

Récupérer les informations de fichier

ID d’opération :: getDocumentInfo

Cet appel d’API récupère des informations détaillées pour un fichier spécifié à partir de la plateforme HighQ Collaborate.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API utilisée.
ID de fichier	fileid	True	string	Spécifie l’ID unique du fichier.
Dernier indicateur d’informations DMS	lastdmsinfo		boolean	Indique s’il faut récupérer les informations les plus récentes du système de gestion des documents.
Type de dossier	foldertype		string	Spécifie le type de dossier le cas échéant.
Inclure les informations d’état du fichier	statusinfo		boolean	Indique s’il faut inclure des informations d’état de fichier supplémentaires telles que l’état partagé, l’état favori, le nombre de tâches et l’état aimé. La valeur par défaut est false.
Inclure les métadonnées d’e-mail	emailmetadata		boolean	Indique s’il faut inclure des métadonnées d’e-mail telles que l’expéditeur, les destinataires et les horodatages. La valeur par défaut est false.

Retours

Corps: DocumentDBO

Récupérer une liste de dossiers

ID d’opération :: getFolderList

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API utilisée.
ID du dossier	folderid	True	string	Spécifie l’ID unique du dossier.
Limite des éléments	limit		string	Spécifie le nombre maximal d’éléments à retourner.
Décalage des éléments	offset		string	Spécifie la position de départ des éléments retournés.
Direction de l’ordre de tri	orderby		string	Spécifie le sens de l’ordre pour le tri des éléments. Utilisez « asc » pour l’ordre croissant ou « desc » pour l’ordre décroissant.
Critère de tri	ordertype		string	Spécifie le critère de tri des éléments, tels que le nom, l’auteur ou la date de dernière modification.
Inclure les informations d’état du dossier	statusinfo		boolean	Indique s’il faut inclure des informations d’état de dossier supplémentaires. La valeur par défaut est false.
Inclure des dossiers intelligents	includesmartfolder		boolean	Indique s’il faut inclure des dossiers intelligents dans la liste retournée. La valeur par défaut est false.

Retours

Nom	Chemin d’accès	Type	Description
folder	folder	array of object
items	folder	object

Récupérer une liste d’éléments iSheet

ID d’opération :: getISheetItems

Cet appel d’API récupère une liste d’éléments contenus dans la feuille iSheet spécifiée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Version de l’API	version	True	string	Spécifie la version de l’API utilisée.
ID iSheet	isheetid	True	integer	Spécifie l’ID unique de la feuille iSheet.
ID d’affichage iSheet	sheetviewid		integer	Spécifie l’ID de l’affichage iSheet. S’il est omis, la vue par défaut est retournée.
ID de colonne de tri	sortcolumnid		integer	Spécifie l’ID de la colonne utilisée pour trier les résultats.
Ordre de tri	sortorder		integer	Spécifie l’ordre de tri. Par exemple, utilisez 0 pour l’ordre croissant ou une autre valeur pour l’ordre décroissant.
Limite d’enregistrement	limit		integer	Spécifie le nombre maximal d’enregistrements à retourner ; la valeur par défaut est 100 si elle n’est pas spécifiée.
Décalage d’enregistrement	offset		integer	Spécifie la position de départ pour la récupération d’enregistrement ; la valeur par défaut est 0 si elle n’est pas spécifiée.
Inclure toutes les colonnes	allColumnRequired		boolean	Indicateur qui indique s’il faut inclure toutes les données de colonne, quel que soit l’affichage actuel.
Ignorer les restrictions d’affichage	isIgnoreView		boolean	Indicateur qui indique s’il faut ignorer les restrictions d’affichage lors de la récupération des données d’élément.

Retours

Nom	Chemin d’accès	Type	Description
isheet	isheet	array of object	Liste des éléments iSheet.
identifiant d'article	isheet.itemId	string	ID unique de l’élément.
données	isheet.data	array of object	Données détaillées de l’élément.
Séquence	isheet.data.sequence	string	Numéro de séquence associé aux données.
columnDisplayName	isheet.data.columnDisplayName	string	Nom complet de la colonne.
value	isheet.data.value	string	Valeur contenue dans la colonne.

Définitions

ErrorDBO

Nom	Chemin d’accès	Type
summary	summary	string
référence	ref	string
link	link	string

DocumentDBO

Nom	Chemin d’accès	Type	Description
docid	docid	string	ID de document.

columns

Nom	Chemin d’accès	Type	Description
N°	column	array of object
items	column	object

LocationDBO

Nom	Chemin d’accès	Type	Description
addressline1	addressline1	string	Première ligne de l’adresse.
addressline2	addressline2	string	Deuxième ligne de l’adresse.
addressline3	addressline3	string	Troisième ligne de l’adresse.
city	city	string	Ville de l’adresse.
état	state	string	État de l’adresse.
country	country	string	Pays de l’adresse.
Cp	postcode	string	Code postal de l’adresse.

Nom d’utilisateur

Nom	Chemin d’accès	Type	Description
title	title	string	Titre de l’utilisateur.
prénom	firstname	string	Prénom de l’utilisateur.
nom de famille	lastname	string	Nom de l’utilisateur.
goby	goesby	string	nom préféré de l’utilisateur.

MetadataListDBO

Nom	Chemin d’accès	Type	Description
metadataname	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	string	ID de lien
nom	name	string	Nom du lien.
value	value	string	Valeur du lien.

Lien

Nom	Chemin d’accès	Type	Description
link	link	array of NameValueLink

ExperiencesDBO

Nom	Chemin d’accès	Type	Description
expérience	experience	array of string

GroupsDBO

Nom	Chemin d’accès	Type	Description
group	group	array of string

utilisateur

Nom	Chemin d’accès	Type	Description
userid	userid	integer	Identifiant utilisateur.
suivant	following	boolean	Suivant.
Messagerie électronique	email	string	Adresse courriel.
nom	name	UserName
userlink	userlink	string	Lien utilisateur.
httplink	httplink	string	Lien HTTP.
httpavatar	httpavatar	string	Avatar HTTP.
avatar	avatar	integer	Avatar de l’utilisateur.
externalid	externalid	string	ID externe.
dateofbirth	dateofbirth	string	Date de naissance.
phone	phone	string	Numéro de téléphone.
jobtitle	jobtitle	string	Titre du travail.
mobile	mobile	string	Numéro de téléphone mobile.
department	department	string	Deparment.
status	status	string	État.
Org	org	string	Organisation.
orgName	orgName	string	Nom de l’organisation.
location	location	LocationDBO
img	img	string	Image.
Expériences	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
messaginglink	messaginglink	Link
secretaryname	secretaryname	string	Nom du secrétaire.
secretarymail	secretarymail	string	Secrétaire Mail.
bio	bio	string	Biographie de l’utilisateur.
sourcetype	sourcetype	string	Type de source.
Spécialités	specialities	string	Spécialités.
reportsto	reportsto	string	Utilisateur à qui l’utilisateur actuel signale.
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
suffixe	suffix	string	Suffixe du nom de l’utilisateur.
atomlink	atomlink	string	Lien Atom associé à l’utilisateur.
link	link	string	Lien associé à l’utilisateur.
loggeduserlike	loggeduserlike	integer	Nombre de likes de l’utilisateur connecté.
nom d’utilisateur	userName	string	Nom d’utilisateur.

users

Nom	Chemin d’accès	Type	Description
utilisateur	user	array of user

FolderDBOV1

Nom	Chemin d’accès	Type	Description
folderid	folderid	string	Identificateur unique du dossier créé.

DmsDBO

Nom	Chemin d’accès	Type	Description
dmsfolderid	dmsfolderid	string	Identificateur du dossier DMS.
dmsParentFolderID	dmsParentFolderID	string	Identificateur du dossier parent DMS.
dmscreateddate	dmscreateddate	date-time	Date de création du dossier DMS.
dmsmodifiedBy	dmsmodifiedBy	string	Utilisateur qui a modifié le dossier DMS pour la dernière fois.
dmsdatabasename	dmsdatabasename	string	Nom de la base de données DMS.
dmslink	dmslink	boolean	Indique si un lien DMS est disponible.
dmslinkby	dmslinkby	string	Utilisateur qui a lié le dossier DMS.

sitegroup

Nom	Chemin d’accès	Type
nom	name	string
pièce d'identité	id	integer
copypermissionsfrom	copypermissionsfrom	string
Message	message	string
typeID	typeID	integer
type	type	string
numberofusers	numberofusers	string
créé	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
descriptif	description	string
basicusergroup	basicusergroup	integer

Adresse

Nom	Chemin d’accès	Type	Description
addressid	addressid	string	Identificateur unique de l’adresse.
addressline1	addressline1	string	Première ligne de l’adresse.
addressline2	addressline2	string	Deuxième ligne de l’adresse.
addressline3	addressline3	string	Troisième ligne de l’adresse.
city	city	string	Ville de l’adresse.
état	state	string	État de l’adresse.
country	country	string	Pays de l’adresse.
Cp	postCode	string	Code postal de l’adresse.
knownas	knownas	string	Autre nom ou surnom de l’adresse.

IntegrationUserDBO

Nom	Chemin d’accès	Type	Description
index	index	integer	Index unique pour l’utilisateur.
userid	userid	integer	Identificateur unique de l’utilisateur.
prénom	firstname	string	Prénom de l’utilisateur.
nom de famille	lastname	string	Nom de l’utilisateur.
practicegroup	practicegroup	string	Groupe pratique auquel appartient l’utilisateur.
langcode	langcode	string	Code de langue de l’utilisateur.
localeID	localeID	string	ID de paramètres régionaux de l’utilisateur.
publicprofile	publicprofile	string	Profil public de l’utilisateur.
pwpid	pwpid	string	ID PWP de l’utilisateur.
usertypeid	usertypeid	string	ID de type utilisateur.
systemuser	systemuser	string	Indicateur utilisateur système.
Messagerie électronique	email	string	Email’adresse de l’utilisateur.
phone	phone	string	Numéro de téléphone de l’utilisateur.
mobile	mobile	string	Numéro mobile de l’utilisateur.
department	department	string	Service de l’utilisateur.
Org	org	string	Organisation à laquelle appartient l’utilisateur.
location	location	LocationDBO
address	address	Address
Expériences	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	ID externe de l’utilisateur.
jobtitle	jobtitle	string	Titre du travail de l’utilisateur.
secretaryname	secretaryname	string	Nom du secrétaire de l’utilisateur.
secretarymail	secretarymail	string	E-mail du secrétaire de l’utilisateur.
Spécialités	specialities	string	Spécialités de l’utilisateur.
title	title	string	Titre de l’utilisateur.
goby	goesby	string	nom préféré de l’utilisateur.
suffixe	suffix	string	Suffixe du nom de l’utilisateur.
atomlink	atomlink	string	Lien Atom associé à l’utilisateur.
bio	bio	string	Biographie de l’utilisateur.
dateOfBirth	dateOfBirth	string	Date de naissance de l’utilisateur.
link	link	string	Lien associé à l’utilisateur.
status	status	string	État de l’utilisateur.
statuscode	statuscode	string	Code d’état de l’utilisateur.
Message	message	string	Message associé à l’utilisateur.
sourcetype	sourcetype	string	Type source de l’utilisateur.
orgid	orgid	string	ID de l’organisation.
ifpartner	ifpartner	string	Indicateur de partenaire.
emaildomain	emaildomain	string	Domaine de messagerie de l’utilisateur.
invitationsent	invitationsent	string	Indicateur d’invitation envoyé.
Créépar	createdby	string	Utilisateur qui a créé l’enregistrement.
createddate	createddate	string	Date de création de l’enregistrement.
modifié par	modifiedby	string	Utilisateur qui a modifié l’enregistrement.
modifieddate	modifieddate	string	Date de modification de l’enregistrement.
lastlogindate	lastlogindate	string	Date de la dernière connexion.
invalidlogins	invalidlogins	string	Nombre de tentatives de connexion non valides.
publicwebsiteprofileid	publicwebsiteprofileid	string	ID de profil du site web public.
resetpassworddate	resetpassworddate	string	Date de réinitialisation du mot de passe.
avatar	avatar	string	URL de l’image avatar.
nombre suivant	followingcount	integer	Nombre d’utilisateurs suivis.
followercount	followercount	integer	Nombre d’abonnés.
suivant	following	boolean	Indicateur suivant.
role	role	string	Rôle de l’utilisateur.
isbasicuser	isbasicuser	string	Indicateur utilisateur de base.
encryptedUserId	encryptedUserId	string	ID d’utilisateur chiffré.
autoinscrire	selfregistered	integer	Indicateur auto-inscrit.
registeredWith2FA	registeredWith2FA	string	Indicateur d’inscription d’authentification à deux facteurs.
estInterne	isInternal	integer	Indicateur utilisateur interne.
orgName	orgName	string	Nom de l’organisation.

site

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	Identificateur de site.
nom_site	sitename	string	Le nom du site.
role	role	string	Rôle du site.
sitedescription	sitedescription	string	Description du site.
enabledmodules	enabledmodules	string	Liste des modules activés pour le site.
sitefolderID	sitefolderID	string	Identificateur du dossier du site.
sitefolderpermission	sitefolderpermission	string	Niveau d’autorisation pour le dossier du site.
module	module	ModuleDBO
adminnote	adminnote	string	Notes administratives relatives au site.
startdate	startdate	string	Date de début de l’opération du site.
enddate	enddate	string	Date de fin de l’opération du site.
createddate	createddate	string	Date de création du site.
archiveddate	archiveddate	string	Date à laquelle le site a été archivé.
clientno	clientno	string	Numéro de client associé au site.
matterno	matterno	string	Numéro de la question associée au site.
page d’accueil	landingpage	string	URL de la page d’accueil du site.
link	link	string	Lien lié au site.
status	status	string	État actuel du site.
statusid	statusid	integer	Identificateur de l’état du site.
size	size	string	Taille du site.
notes de facturation	billingnotes	string	Remarques relatives à la facturation du site.
billingnextinvoicedate	billingnextinvoicedate	string	Date de la facture suivante pour le site.
billinglastinvoicedate	billinglastinvoicedate	string	Date de la dernière facture du site.
filepagecount	filepagecount	string	Nombre total de fichiers sur le site.
maxpagecount	maxpagecount	string	Nombre maximal de pages autorisés pour les fichiers sur le site.
sitehttplink	sitehttplink	string	Lien HTTP vers le site.
isSyncable	isSyncable	integer	Indique si le site est synchronisé.
enforceusergroups	enforceusergroups	string	Les groupes d’utilisateurs appliqués pour le site.
csvSiteCategory	csvSiteCategory	string	Catégorie du site au format CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Nom du site dans la langue par défaut.
visible	visible	integer	Indique si le site est visible.
siteLogoName	siteLogoName	string	Nom du fichier logo du site.
siteLogoFileSize	siteLogoFileSize	integer	Taille du fichier du logo du site.
siteLogoHeight	siteLogoHeight	integer	Hauteur du logo du site.
siteLogoWidth	siteLogoWidth	integer	Largeur du logo du site.
siteStatus	siteStatus	integer	Code d’état du site.
applySiteTerms	applySiteTerms	integer	Indique si les termes du site sont appliqués.
siteTerm	siteTerm	string	Conditions appliquées au site.
termType	termType	integer	Type de termes appliqués au site.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Indique si les termes du site sont requis lors de la prochaine connexion.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Indique si les termes du site par défaut sont activés.
advancedQAPermission	advancedQAPermission	integer	Niveau d’autorisation QA avancé pour le site.
estInterne	isInternal	integer	Indique si le site est interne.
Psm	psm	integer	Identificateur Product Service Manager.
siteLabelDisplay	siteLabelDisplay	string	Étiquette d’affichage du site.
allowSiteAdministration	allowSiteAdministration	integer	Indiquant si l’administration du site est autorisée.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Pour activer la protection par mot de passe au niveau du site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Pour activer la protection du code secret au niveau du site.
code secretUsingAuthApp	passcodeUsingAuthApp	integer	Indique si l’authentification par code secret utilise une application d’authentification.
sitePassword	sitePassword	string	Mot de passe associé au site.
ipRestrictionEnable	ipRestrictionEnable	integer	Pour activer les restrictions IP pour l’accès au site.
availableIP	availableIP	string	Liste séparée par des virgules d’adresses IP autorisées à accéder au site.
highqDrive	highqDrive	integer	Indique si l’intégration de Lecteur HighQ est activée.
applySiteHomePage	applySiteHomePage	integer	Pour appliquer une page d’accueil personnalisée pour le site.
siteHomePage	siteHomePage	string	URL de la page d’accueil personnalisée du site.
siteHomePageType	siteHomePageType	integer	Type de la page d’accueil.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Pour définir la connexion suivante à la page d’accueil du site.
applyDisplayContent	applyDisplayContent	integer	Pour appliquer les paramètres d’affichage du contenu.
displayContent	displayContent	string	Contenu à afficher sur le site.
rssSecurity	rssSecurity	integer	Niveau de sécurité du flux RSS.
cryptéMot de passe	encryptedPassword	integer	Indique si le mot de passe du site est chiffré.
availableIPRangeCSV	availableIPRangeCSV	string	Liste séparée par des virgules des plages d’adresses IP autorisées à accéder au site.
siteModuleID	siteModuleID	integer	Identificateur du module de site.
icalSecurity	icalSecurity	integer	Niveau de sécurité du flux iCal.
defaultDisplayContent	defaultDisplayContent	string	Contenu par défaut à afficher sur le site.
defaultEmailAlert	defaultEmailAlert	integer	Pour activer les alertes par e-mail par défaut.
excelReportFooter	excelReportFooter	integer	Inclut un pied de page dans les rapports Excel.
excelReportFooterText	excelReportFooterText	string	Texte à afficher dans le pied de page des rapports Excel.
announcementMLJSON	announcementMLJSON	string	Annonces au format JSON pour le site.
templateType	templateType	integer	Type de modèle utilisé pour le site.
templateLicence	templateLicence	integer	Type de licence pour le modèle de site.
openChannelAppID	openChannelAppID	string	ID d’application pour l’intégration du canal ouvert.
itemid	itemid	integer	Identificateur de l’élément associé au site.
sitemetadatasheetid	sitemetadatasheetid	integer	ID de la feuille de métadonnées associée au site.
mysite	mysite	boolean	Indique s’il s’agit du site personnel de l’utilisateur.
lastaccesseddate	lastaccesseddate	string	Date et heure auxquelles le site a été consulté pour la dernière fois.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Onglet métadonnées par défaut pour la visionneuse de site.
documentMetadataViewId	documentMetadataViewId	integer	métadonnées de document pour l’identificateur d’affichage.
folderMetadataViewId	folderMetadataViewId	integer	métadonnées de dossier pour l’identificateur d’affichage.
docSort	docSort	integer	Ordre de tri des documents.
folderSort	folderSort	integer	Ordre de tri des dossiers.
defaultFolderRenderView	defaultFolderRenderView	integer	Détermine le mode d’affichage par défaut pour les dossiers.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Emplacement par défaut des pièces jointes de tâche.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Identificateur unique du dossier désigné comme emplacement par défaut pour les pièces jointes de tâche.
favori	favourite	string	statut favori.
enabledocumentredaction	enabledocumentredaction	boolean	Spécifie si la rédaction de document est activée pour le site.
mentiongroups	mentiongroups	integer	Groupes mentionnés.
enablefilerelationships	enablefilerelationships	boolean	Indique si les relations de fichier sont activées.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Niveau d’autorisation requis pour gérer les relations de fichiers.

ModuleDBO

Nom	Chemin d’accès	Type
domicile	home	HomeDBO
activité	activity	ActivityDBO
document	document	DocumentDBO
Blog	blog	BlogDBO
wiki	wiki	WikiDBO
tâche	task	TaskDBO
événement	event	EventDBO
isheet	isheet	ISheetDBO
Qa	qa	QaDBO
contacts	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Nom	Chemin d’accès	Type	Description
Activer	enable	string	Activer l’état de HomeDBO.

ActivityDBO

Nom	Chemin d’accès	Type	Description
Activer	enable	string	Activer l’état de ActivityDBO.
microblog	microblog	string	Contenu de microblog associé à ActivityDBO.

BlogDBO

Nom	Chemin d’accès	Type	Description
blogTitle	blogTitle	string	Titre du billet de blog.
blogContent	blogContent	string	Contenu du billet de blog.
showComment	showComment	integer	affichez le commentaire.
tagList	tagList	array of string	Liste des balises associées au blog.
status	status	integer	état du billet de blog.
siteID	siteID	integer	Identificateur du site associé.
author	author	string	Auteur du blog.
categoryList	categoryList	array of string	Catégories affectées au billet de blog.
notificationTypeID	notificationTypeID	integer	Identificateur du type de notification.
Message	message	string	Contenu du message lié au blog.
messageCode	messageCode	integer	Code associé au message.
identifiant externe	externalID	string	Identificateur externe lié au blog.
publishDate	publishDate	string	Date de publication du blog.
processtype	processtype	string	Type de processus associé au blog.
Activer	enable	string	Activer l’état pour BlogDBO.

WikiDBO

Nom	Chemin d’accès	Type	Description
wikiid	wikiid	integer	Identificateur unique pour le wiki.
currentversionid	currentversionid	integer	Identificateur de la version actuelle du wiki
parentwikiid	parentwikiid	integer	Identificateur du wiki parent.
wikititle	wikititle	string	Titre du wiki.
wikicontent	wikicontent	string	Contenu du wiki.
showcomment	showcomment	integer	Indiquant si les commentaires sont activés.
createddate	createddate	string	Date de création du wiki.
modifieddate	modifieddate	string	Date de dernière modification du wiki.
taglist	taglist	string	Liste séparée par des virgules des balises associées au wiki.
wikipath	wikipath	string	Chemin d’accès au wiki.
wikidraftid	wikidraftid	integer	Identificateur de la version brouillon du wiki.
brouillon	drafttype	string	Type de brouillon associé au wiki.
status	status	integer	État actuel du wiki.
wikiversionid	wikiversionid	integer	Identificateur de version du wiki.

TaskDBO

Nom	Chemin d’accès	Type	Description
index	index	string	Index ou identificateur de la tâche.
parenttaskid	parenttaskid	integer	Identificateur de la tâche parente.
taskid	taskid	integer	Identificateur unique de la tâche.
title	title	string	Titre de la tâche.
descriptif	description	string	Description détaillée de la tâche.
duedate	duedate	string	Date d’échéance de la fin de la tâche.
startdate	startdate	string	Date de début de la tâche.
mattermaptaskid	mattermaptaskid	string	Identificateur lié à la tâche de mappage de matière.
type	type	string	Type ou catégorie de la tâche.
dependenton	dependenton	string	Les tâches dont dépend cette tâche.
daysfromdependent	daysfromdependent	string	Nombre de jours à partir de la tâche dépendante.
ignoreweekend	ignoreweekend	integer	Indique si les week-ends sont ignorés dans la planification.
duration	duration	integer	Durée d’exécution de la tâche.
resource	resource	string	Ressources affectées à la tâche.

EventDBO

Nom	Chemin d’accès	Type	Description
eventTitle	eventTitle	string	Titre de l’événement.
eventContent	eventContent	string	Contenu de l’événement.
showComment	showComment	integer	Indiquant si les commentaires sont activés pour l’événement.
tagList	tagList	array of string	Liste des balises associées à l’événement.
status	status	integer	État actuel de l’événement.
siteID	siteID	integer	Identificateur du site.
contacter	contact	string	Informations de contact pour l’événement.
categoryList	categoryList	array of string	Catégories sous lesquelles l’événement est répertorié.
notificationTypeID	notificationTypeID	integer	Type de notification lié à l’événement.
Message	message	string	Message de l’événement.
messageCode	messageCode	integer	Code de message de l’événement.
identifiant externe	externalID	string	Identificateur externe.
date de début	startDate	string	Date de début de l’événement.
date de fin	endDate	string	Date de fin de l’événement.
startTime	startTime	string	Heure de début de l’événement.
endTime	endTime	string	Heure de fin de l’événement.
location	location	string	Emplacement de l’événement.
author	author	string	Auteur de l’événement.
processtype	processtype	string	Heure de processus de l’événement.
Activer	enable	string	Activez l’événement.

ISheetDBO

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	Identificateur unique de la feuille iSheet.
title	title	string	Titre de la feuille iSheet.
descriptif	description	string	Description de la feuille isheet.
status	status	string	État de la feuille isheet.
accesstype	accesstype	string	Type d’accès de la feuille isheet.
type	type	string	Type de la feuille isheet.
viewlink	viewlink	string	Lien pour afficher la feuille iSheet.
allowsections	allowsections	string	Indique si les sections sont autorisées.
allowlookup	allowlookup	string	Indique si les champs de recherche sont activés.
displayisheet	displayisheet	string	Options d’affichage de la feuille iSheet.
searchasdefaultview	searchasdefaultview	string	Indique si la recherche est en mode par défaut.
enableversion	enableversion	string	Indicateur activé pour le contrôle de version.
enablesheetalerter	enablesheetalerter	string	Indicateur pour activer les alertes de feuille.
alertercondition	alertercondition	string	Conditions pour déclencher des alertes.
overrideitemmodifieddate	overrideitemmodifieddate	string	Remplacer l’indicateur de date de modification.
enablebulkinsertupdate	enablebulkinsertupdate	string	Activez l’insertion/mise à jour en bloc.
fielddescriptions	fielddescriptions	string	Descriptions des champs de l’iSheet.
enablerowlocking	enablerowlocking	string	Activer le verrouillage au niveau des lignes.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Tronquer l’indicateur de texte multiligne.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Limite de caractères pour la troncation multiligne.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Autorisez la réutilisation des valeurs de liste de choix.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Autorisez la réutilisation des valeurs de liste de score.
allowIsheetComments	allowIsheetComments	string	Autoriser les commentaires dans iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Limite des enregistrements autorisés à partager.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Limite de partage d’enregistrements activée.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Activez le partage de formulaires pour l’ajout d’enregistrements.
recordcount	recordcount	string	Nombre d’enregistrements actuel.
sheettypeid	sheettypeid	integer	ID de type de la feuille iSheet

QaDBO

Nom	Chemin d’accès	Type	Description
Activer	enable	string	Activer la fonctionnalité DQ.

PeopleDBO

Nom	Chemin d’accès	Type	Description
personne	person	array of PersonDBO

PersonDBO

Nom	Chemin d’accès	Type	Description
userid	userid	integer	Identifiant utilisateur.
Messagerie électronique	email	string	adresse courriel.
httpavatar	httpavatar	string	URL HTTP de l’avatar.
avatar	avatar	string	Image avatar.
userlink	userlink	string	Lien vers le profil utilisateur.
httplink	httplink	string	Lien HTTP vers le profil utilisateur.
phone	phone	string	Numéro de téléphone.
mobile	mobile	string	Numéro de téléphone mobile.
department	department	string	Service de l’utilisateur.

ContractExpressDBO

Nom	Chemin d’accès	Type	Description
Activer	enable	string	Activez l’intégration de Contract Express.

FolderDBOV2

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom du dossier.
descriptif	description	string	Description du dossier.
parentFolderID	parentFolderID	integer	ID de dossier parent.
accessInherited	accessInherited	integer	État de l’héritage d’accès.
batchID	batchID	string	Identificateur de lot
Dms	dms	DmsDBO
pièce d'identité	id	integer	ID de dossier.
link	link	string	Lien de dossier.
createddate	createddate	string	Date de création.
modifieddate	modifieddate	string	Date de modification.
enfant	child	integer	Dossiers enfants.
filecount	filecount	integer	Nombre de fichiers.
Créépar	createdby	UserDBO
modifié par	modifiedby	UserDBO
folderid	folderid	integer	ID de dossier.
dmsfolderid	dmsfolderid	string	Identificateur du dossier DMS.
siteid	siteid	integer	ID de site
location	location	string	Emplacement du dossier.
autorisation	permission	PermissionDBO
contentstatus	contentstatus	integer	État du contenu.
numérotage automatique	autonumbering	string	Configuration de numérotation automatique.
foldersize	foldersize	string	Taille du dossier.
sharedstatus	sharedstatus	integer	État du partage.
favoritestatus	favouritestatus	integer	État favori.
foldertype	foldertype	string	Type de dossier.
identifiant d'article	itemId	integer	Identificateur de l'élément.
folderMetadataSheetId	folderMetadataSheetId	integer	Métadonnées de dossier de l’ID de feuille.

UserDBO

Nom	Chemin d’accès	Type	Description
prénom	firstname	string	Prénom.
nom de famille	lastname	string	Nom.
Messagerie électronique	email	string	Adresse e-mail.
userid	userid	integer	Identifiant utilisateur.

PermissionDBO

Nom	Chemin d’accès	Type	Description
view	view	integer	Afficher l’autorisation.
edit	edit	integer	Modifier l’autorisation.
delete	delete	integer	Supprimer l’autorisation.
addEditAllFiles	addEditAllFiles	integer	Ajouter/modifier toutes les autorisations de fichiers.
Admin	admin	integer	Autorisation d’administrateur.
viewAllFiles	viewAllFiles	integer	Affichez l’autorisation de tous les fichiers.
disableSave	disableSave	integer	désactivez l’autorisation d’enregistrement.
uploadFile	uploadFile	integer	charger l’autorisation de fichier.
updateFile	updateFile	integer	mettre à jour l’autorisation de fichier.
deleteFile	deleteFile	integer	Supprimer l’autorisation de fichier.

ProgressiveKeyDBO

Nom	Chemin d’accès	Type	Description
progressivekey	progressivekey	string	Clé pour les opérations progressives.
siteid	siteid	integer	Identificateur du site.
progressivekeystatus	progressivekeystatus	string	État de la clé progressive.
userid	userid	integer	Identificateur de l’utilisateur.
responsebody	responsebody	string	Corps de la réponse.
Message	message	string	Contenu du message.
messagecode	messagecode	string	Code associé au message.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
erreur	error	ErrorDBO
type de contenu	contentType	string	Type de contenu.
failedEntities	failedEntities	integer	Nombre d’entités ayant échoué.
downloadlink	downloadlink	string	Lien pour télécharger du contenu.
attachement	attachment	Attachment
link	link	string	Lien associé.
documentid	documentid	integer	Identificateur du document.
progresskey	progresskey	string	Clé de progression pour le suivi.
progresskeystatus	progresskeystatus	string	État de la clé de progression.

IntegrationResponseDBO

Nom	Chemin d’accès	Type	Description
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
failedEntities	failedEntities	integer	Nombre d’entités qui ont échoué au traitement.
successEntities	successEntities	integer	Nombre d’entités qui ont été correctement traitées.

IntegrationResponseUsersObject

Nom	Chemin d’accès	Type	Description
utilisateur	user	array of IntegrationUserDBO

ColumnErrorsDBO

Nom	Chemin d’accès	Type	Description
N°	column	array of ColumnErrorDBO
failedEntities	failedEntities	integer	Nombre d’entités ayant échoué en raison d’erreurs de colonne.
successEntities	successEntities	integer	Nombre d’entités qui ont été correctement traitées.

ColumnErrorDBO

Nom	Chemin d’accès	Type	Description
index	index	integer	Position d’index de la colonne avec erreur.
columnid	columnid	integer	Identificateur unique de la colonne avec erreur.
nom	name	string	Nom de la colonne avec erreur.
status	status	string	État indiquant la condition d’erreur.
statuscode	statuscode	string	Code représentant l’état d’erreur.
Message	message	string	Message d’erreur détaillé.

ItemErrorsDBO

Nom	Chemin d’accès	Type	Description
item	item	array of ItemErrorDBO
failedEntities	failedEntities	integer	Nombre d’entités ayant échoué en raison d’erreurs d’élément.
successEntities	successEntities	integer	Nombre d’entités qui ont été correctement traitées malgré les erreurs d’élément.

ItemErrorDBO

Nom	Chemin d’accès	Type	Description
index	index	integer	Position d’index de l’élément avec erreur.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Identificateur unique de l’élément avec erreur.
externalid	externalid	string	Identificateur externe associé à l’élément.
pièce d'identité	id	string	Identificateur interne de l’élément.
nom	name	string	Nom de l’élément avec erreur.
status	status	string	État indiquant la condition d’erreur.
statuscode	statuscode	string	Code représentant l’état d’erreur.
Message	message	string	Message d’erreur détaillé.
successdeletedcount	successdeletedcount	integer	Nombre d’entités supprimées avec succès.
failurecount	failurecount	integer	Nombre d’entités qui ont échoué au traitement.
failedEntities	failedEntities	integer	Nombre d’entités ayant échoué en raison d’erreurs d’élément.
successEntities	successEntities	integer	Nombre d’entités qui ont été correctement traitées.

importISheetTemplateDBO

Nom	Chemin d’accès	Type	Description
linkedtemplateid	linkedtemplateid	integer	Identificateur du modèle lié.
aliasname	aliasname	string	Nom de l’alias du modèle.
linkedisheet	linkedisheet	string	Identificateur de la feuille d’entrée liée.
importdata	importdata	string	Données à importer à partir du modèle.
appendisheetname	appendisheetname	string	Nom de la feuille à laquelle ajouter des données.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
identifiant de modèle	templateId	integer	Identificateur du modèle.
templateTitle	templateTitle	string	Titre du modèle.
viewIDs	viewIDs	string	Liste séparée par des virgules des ID d’affichage.

ISheetTemplateParameterGroups

Nom	Chemin d’accès	Type	Description
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Nom	Chemin d’accès	Type	Description
templateruleid	templateruleid	integer	Groupe de paramètres de modèle Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	Identificateur du paramètre de modèle isheet.
nom	name	string	Nom du paramètre de modèle isheet.
données	data	string	données du paramètre de modèle isheet.

Pièce jointe

Nom	Chemin d’accès	Type	Description
file	file	string	Contenu du fichier.
nom	name	string	Nom de fichier de la pièce jointe
order	order	string	Ordre de la pièce jointe.
pièce d'identité	id	integer	Identificateur unique de la pièce jointe.
extension	extension	string	Extension de fichier.
parentfolderid	parentfolderid	integer	ID du dossier parent.
filehttplink	filehttplink	string	Lien HTTP pour accéder au fichier.
chemin du dossier	folderpath	string	Chemin d’accès au dossier contenant le fichier.
folderhttplink	folderhttplink	string	Lien HTTP vers le dossier.
fichiersize	filesize	integer	Taille du fichier en octets.
redactionStatus	redactionStatus	boolean	Indique si le fichier est supprimé.
displayname	displayname	string	Nom complet de la pièce jointe.
siteid	siteid	integer	ID du site associé à la pièce jointe.

Partager via

HighQ (préversion)

HighQ

Aperçu

Authentication

Opérations du connecteur

ISheet Module

API de ressource de document

API d’administration ISheet

Opérations utilisateur

Gestion des documents et des sites

Getting Started

Paramètres et paramètres

Résolution des problèmes et limitations

Ressources additionnelles

Licences et support

Limitations

Actions

Ajouter un groupe existant au site

Paramètres

Retours

Ajouter un site

Paramètres

Retours

Ajouter un utilisateur

Paramètres

Retours

Archiver l’utilisateur

Paramètres

Charger un fichier

Paramètres

Créer un dossier

Paramètres

Retours

Déplacer des documents

Paramètres

Mettre à jour le groupe de sites

Paramètres

Retours

Mettre à jour le site

Paramètres

Obtenir des informations sur les dossiers

Paramètres

Retours

Pour créer l’élément iSheet

Paramètres

Retours

Récupérer des colonnes iSheet

Paramètres

Retours

Récupérer la liste des utilisateurs

Paramètres

Retours

Récupérer les informations de fichier

Paramètres

Retours

Récupérer une liste de dossiers

Paramètres

Retours

Récupérer une liste d’éléments iSheet

Paramètres

Retours

Définitions

ErrorDBO

DocumentDBO

columns

LocationDBO

Nom d’utilisateur

MetadataListDBO

NameValueLink

Lien

ExperiencesDBO

GroupsDBO

utilisateur

users

FolderDBOV1

DmsDBO

sitegroup

Adresse

IntegrationUserDBO