Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13

From version 47.1
edited by Aurelie Bertrand
on 2024/08/30 10:20
Change comment: There is no comment for this version
To version 50.1
edited by Aurelie Bertrand
on 2024/09/04 10:10
Change comment: Renamed from dev:API.WebHome

Summary

Details

Page properties
Content
... ... @@ -121,26 +121,26 @@
121 121  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
122 122  1. Cliquez sur **Authorize**.
123 123  
124 -= API disponibles =
124 += Ressources API disponibles =
125 125  
126 -== Liste des API ==
126 +== Liste des ressources ==
127 127  
128 -Les API disponibles sont classées par type :
128 +Les ressources disponibles sont classées par type :
129 129  
130 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
131 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
132 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
133 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
134 -* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
130 +* **Authentification **: pour la création des jetons de sécurité (JWT)
131 +* **User Management** : pour lgestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
132 +* **System** : pour les informations système, service d'audit et ordonnanceur.
133 +* **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
134 +* **Event Management** : pour l'ajout d'évènements avec fireEvent.
135 135  
136 136  (% class="box infomessage" %)
137 137  (((
138 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
138 +ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
139 139  )))
140 140  
141 141  == Opérations disponibles ==
142 142  
143 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
143 +Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
144 144  
145 145  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
146 146  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -153,7 +153,7 @@
153 153  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
154 154  (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes :
155 155  
156 -1. (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
156 +1. (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Développez une ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
157 157  1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
158 158  1. (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Dans la fenêtre de méthode développée, cliquez sur **Try it out **(Essayer) .
159 159  1. (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée ci-dessous.