Différences entre versions de « WebAPI BddBackup.Backup »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| (4 versions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
| − | {{DebutInfoCartographe}}{{Jusqua| | + | {{DebutInfoCartographe}}{{Jusqua|7.01}} |
L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. | 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 : [[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'>< | + | <div id='api-body'><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>http://localhost/core/api/BddBackup.Backup</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.BddBackup+BackupResponse|BackupResponse]]</span> <span class='method-name'>BddBackup.Backup</span><span class='parameters'> (<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>skipLogs</span> = False]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>skipPhotos</span> = False]</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'>skipLogs</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Vrai pour ne pas inclure les journaux dans la sauvegarde. Nécessite un accès maintenance.</span></td></tr><tr><th class='parameter-name'>skipPhotos</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Vrai pour ne pas inclure la définition des photos et des pièces jointes dans la sauvegarde. Nécessite un accès maintenance.</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.BddBackup+BackupResponse|BackupResponse]]</td><td class='return-doc'>Information sur la future sauvegarde, si elle aboutie</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;'>Posséder le droit «<span class='security-elt'>autorisation d'effectuer une sauvegarde de la base de données</span>»</p></div></div> |
| − | {{FinInfoCartographe}}[[Catégorie:Webservice | + | {{FinInfoCartographe}}[[Catégorie:Webservice BddBackup|Backup]] |
Version actuelle datée du 25 février 2019 à 11:12
Cette fonctionnalité n'est plus disponible depuis la version 7.01
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 : http://localhost/core/api/BddBackup.Backup
BackupResponse BddBackup.Backup ([Boolean skipLogs = False], [Boolean skipPhotos = False], [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 |
|---|---|---|
| skipLogs | Boolean | (optionnel, par défaut: False) Vrai pour ne pas inclure les journaux dans la sauvegarde. Nécessite un accès maintenance. |
| skipPhotos | Boolean | (optionnel, par défaut: False) Vrai pour ne pas inclure la définition des photos et des pièces jointes dans la sauvegarde. Nécessite un accès maintenance. |
| output | xml|json | (optionnel, par défaut: xml) Format de la réponse |
| Retour | BackupResponse | Information sur la future sauvegarde, si elle aboutie |
Politique de sécurité et règles d'accès à l'API :
Posséder le droit «autorisation d'effectuer une sauvegarde de la base de données»