Différences entre versions de « WebAPI Bdd.LaunchBackup »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| Ligne 4 : | Ligne 4 : | ||
Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]]. | Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]]. | ||
| − | <div id='api-body'><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'> | + | <div id='api-body'><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/core/api/Bdd.LaunchBackup</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Bdd+BackupResponse|BackupResponse]]</span> <span class='method-name'>Bdd.LaunchBackup</span><span class='parameters'> (<span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepClient.Constantes.SauvegardeConfig|SauvegardeConfig]]</span> <span class='parameter-name'>options</span> = Full]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Déclenche la sauvegarde de la base de données et renvoi les informations sur cette future sauvegarde</p><div class='args'><p><span class='lbl'>Arguments :</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>options</th><td class='parameter-type'>[[WebAPI Type RepClient.Constantes.SauvegardeConfig|SauvegardeConfig]]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: Full)<br/></span><span class='param-doc'>Configuration de la sauvegarde</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Bdd+BackupResponse|BackupResponse]]</td><td class='return-doc'>Vrai si la sauvegarde a été déclenchée</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API :</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée : <ul><li>être connecté au serveur en mode réplication</li><li>Posséder le droit «<span class='security-elt'>autorisation d'effectuer une sauvegarde de la base de données</span>»</li></ul></p></div></div> |
{{FinInfoCartographe}}[[Catégorie:Webservice Bdd|LaunchBackup]] | {{FinInfoCartographe}}[[Catégorie:Webservice Bdd|LaunchBackup]] | ||
Version du 18 juillet 2022 à 10:23
Disponible depuis la version 7.04
L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).
Appel Web : https://nur298.ws-dev.polarisgestionmag.net/core/api/Bdd.LaunchBackup
BackupResponse Bdd.LaunchBackup ([SauvegardeConfig options = Full], [xml|json output = xml ])
Déclenche la sauvegarde de la base de données et renvoi les informations sur cette future sauvegarde
Arguments :
| Nom | Type | Description |
|---|---|---|
| options | SauvegardeConfig | (optionnel, par défaut: Full) Configuration de la sauvegarde |
| output | xml|json | (optionnel, par défaut: xml) Format de la réponse |
| Retour | BackupResponse | Vrai si la sauvegarde a été déclenchée |
Politique de sécurité et règles d'accès à l'API :
au moins une des conditions suivantes doit être vérifiée :
- être connecté au serveur en mode réplication
- Posséder le droit «autorisation d'effectuer une sauvegarde de la base de données»