Cegid XRP Ultimate | I3 Actualisé le 06/10/2022 |
|||
| Fondations | |||
| WebServices Fondations | |||
| Ensemble des WebServices définis. |
| Fondations : WebServices REST |
| WebServices pour la gestion des documents |
| Recherche de la GED |
| WebService permettant de retourner l'ensemble des documents trouvés par les critères de recherche. En retour : Json contenant les caractéristiques des documents + jetons permettant l'accès direct aux documents (jetons ayant une durée de vie limitée). |
| Nom : documentsReferencing/search |
| Accès à la GED |
| WebService permettant de retourner un "stream" correspondant au fichier demandé. |
| Nom : documentsReferencing/query |
| Ecriture de la GED |
| WebService permettant d'insérer un document en GED en fournissant, en entrée, le "stream" à charger. |
| Nom : documentsReferencing |
| Suppression de la GED |
| WebService permettant de supprimer le document passé en entrée. |
| Nom : documentsReferencing |
| WebServices sur les traitements (travaux) |
| Recherche des informations sur un job et son compte rendu |
| WebService permettant de rechercher des informations sur un job, c'est-à-dire : - toutes les propriétés renseignées du job (CJOB) ; - toutes les propriétés renseignées des comptes rendus (GTJCR). |
| Nom : jobsInformation |
| Recherche du fichier résultat d'un job |
| WebService permettant d'obtenir le fichier résultat d'un job sous forme de "stream", avec le nom du fichier dans le "header". |
| Nom : jobFileResult |
| Lecture des fichiers d'un job |
| WebService permettant d'obtenir tous les fichiers générés par un job. |
| Nom : jobFiles |
| Recherche de l'état d'un job |
| WebService permettant d'obtenir l'état d'un job. |
| Nom : jobStatus |
| Exécution d'un job |
| WebService permettant de lancer un traitement batch (job) sur le serveur de traitements de Cegid XRP Ultimate. Possibilité de lancement immédiat ou attente (sous conditions) de la fin du traitement. |
| Nom : jobs |
| WebServices des utilisateurs |
| Création d'un utilisateur |
| WebService de création d'un utilisateur en se basant sur un modèle et en lui précisant ses profils. Ce WebService ne crée pas l'utilisateur de type "Simple" dans le détail des utilisateurs (GTIUSD) ; cette création est adaptée lorsque la connexion de l'utilisateur est de type SSO ou via l'interface avec un annuaire LDAP. |
| Nom : users |
| Suppression d'un utilisateur ou d'une liste d'utilisateurs |
| WebService de suppression d'un utilisateur ainsi que des informations s'y rapportant. On peut supprimer soit un seul utilisateur, soit tous les utilisateurs contenus dans une liste. |
| Nom : users |
| Duplication d'un utilisateur à partir d'un modèle |
| WebService de duplication d'un utilisateur à partir d'un modèle. Ce nouvel utilisateur dupliqué pourra se connecter via l'interface d'un annuaire LDAP ou directement à partir de la connexion standard. |
| Nom : usersFromModel |
| Duplication d'un poste utilisateur à partir d'un modèle |
| WebService de duplication d'un poste de travail à partir d'un modèle. |
| Nom : workstationsFromModel |
| Mise à jour d'une délégation |
| WebService permettant de modifier les informations d'une délégation avec recalcul de la sécurité. |
| Nom : delegations |
| Mise à jour d'un utilisateur |
| WebService de modification d'un utilisateur. |
| Nom : usersWithManager |
| WebServices Query |
| Lancement d'une requête prédéfinie |
| WebService permettant d'exécuter une requête SQL prédéfinie dans Cegid XRP Ultimate et d'en retourner le résultat. Les grands principes sont les suivants : - écriture de la requête à lancer via les gestions de Workflow Information Manager (GTUREQ, etc.) ; - possibilité de prédéfinir des conditions dynamiques ; - format en sortie JSON ou CSV. |
| Nom : genericQuery |
| Lancement d'une requête prédéfinie (flux) |
| WebService permettant d'exécuter une requête SQL prédéfinie dans Cegid XRP Ultimate et d'en retourner le résultat sous forme de stream (flux). |
| Nom : genericQueryAsStream |
| Lancement d'une requête simple |
| WebService dont le principe est de lancer une requête sur n'importe quelle table sans avoir à écrire la requête SQL (select) via l'interface utilisateur Cegid XRP Ultimate. C'est donc à l'appel du WebService que la table à lire doit être précisée, ainsi que les critères de sélection à appliquer, les colonnes à retourner, etc. Le format en sortie est JSON ou CSV. |
| Nom : autoGeneratedQuery |
| Lancement d'une requête simple (flux) |
| WebService dont le principe est de lancer une requête simple sur n'importe quelle table sans avoir à écrire la requête SQL (select). Le résultat est retourné sous forme de stream (flux). |
| Nom : autoGeneratedQuerysStream |
| WebServices XLinks |
| Lancement d'un traitement XLinks |
| WebService permettant de lancer un traitement de type XLinks en fournissant les critères du traitement et le fichier de données. |
| Nom : interface |
| Autres (techniques) |
| Simulation d'une erreur |
| WebService permettant de simuler une erreur. Il peut être utilisé potentiellement par toutes les applications (pas de référencement dans un Module). |
| Nom : crash |
| Enchaînement dynamique |
| WebService permettant de lancer un traitement de type "Enchaînement dynamique". Il peut être utilisé potentiellement par toutes les applications (pas de référencement dans un Module). |
| Nom : dynamicsTransactions |
| Vider le "cache" |
| WebService permettant de vider une partie du "cache" coté Serveur Web Service (globales, cache sécurité Fondations, etc.). |
| Nom : clearCache |
| Version des librairies |
| WebServices donnant la version des librairies noyau des WebServices. |
| Nom : libsVersion |
| Date et heure d'une base de données |
| WebService de test, qui retourne la date et l'heure depuis la base de données (nécessite une authentification préalable). |
| Nom : timeFromDataBase |
| Date et heure d'un serveur |
| WebService de test, qui retourne la date et l'heure du serveur Web (nécessite une authentification préalable). |
| Nom : timeFromServer |
| Création API Key |
| WebService permettant de générer une API Key associée à un utilisateur. Nécessite une authentification préalable avec un utilisateur possédant les droits de créer un utilisateur. |
| Nom : apiKey |
| Authentification |
| WebService permettant de s'authentifier en passant les informations dans un objet JSON. |
| Nom : authentication |
| Authentification (formulaire) |
| WebService permettant de s'authentifier en passant les informations dans des paramètres de formulaire. |
| Nom : authenticationForm |
| Jeton d'authentification |
| WebService permettant de renouveler le jeton d'authentification. |
| Nom : renewToken |
| Changement de mot de passe |
| WebService permettant de modifier le mot de passe (ancien mot de passe demandé). |
| Nom : changePassword |
| Mot de passe oublié |
| WebService permettant de demander un nouveau de mot de passe (via envoi de mail). |
| Nom : lostPassword |
| Se déconnecter |
| WebService permettant de quitter le produit en se déconnectant. |
| Nom : disconnect |
| Paramètre "action" de WimServlet |
| WebService appelant des fonctionnalités basées sur le paramètre "action" de WimServlet. Reste présent pour certains besoins de rétrocompatibilité, mais il est conseillé d'utiliser en priorité les services dédiés. |
| Nom : action |
| Procédures stockées |
| WebService permettant l'appel des procédures stockées de Cegid XRP Ultimate. |
| Nom : callProc |