Différences entre versions de « WebAPI Logs.Download »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| Ligne 1 : | Ligne 1 : | ||
| − | {{DebutInfoCartographe}}{{ | + | {{DebutInfoCartographe}}{{Depuis|6.02}} |
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'><p class='prp'>L'API Logs permet de gérer tout ce qui est relatif au système de journalisation</p> | + | <div id='api-body'><p class='prp'>L'API Logs permet de gérer tout ce qui est relatif au système de journalisation</p> |
| + | == Methode Logs.Download == | ||
| + | <p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>http://localhost/core/api/Logs.Download</span></p><p class='signature'><span class='return-type'>void</span> <span class='method-name'>Logs.Download</span><span class='parameters'> (<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</span> <span class='parameter-name'>date</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime (Optionnel)]</span> <span class='parameter-name'>dateFin</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>NUR</span> = -1]</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'>zip</span> = True]</span>)</span></p><p class='mrp'>Renvoi la journalisation aux dates souhaitées pour le NUR souhaité</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'>date</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</td><td class='parameter-txt'><span class='param-doc'>Date de début du journal souhaité</span></td></tr><tr><th class='parameter-name'>dateFin</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime (Optionnel)]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Date de fin du journal souhaité, null s'il faut interpréter la date de début comme une date fixe</span></td></tr><tr><th class='parameter-name'>NUR</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: -1)<br/></span><span class='param-doc'>Numéro du service de réplication souhaité, -1 pour le service de réplication courant, -2 pour tous</span></td></tr><tr><th class='parameter-name'>zip</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: True)<br/></span><span class='param-doc'>Renvoi le journal au format compressé</span></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>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>être identifié</li></ul></p></div></div> | ||
{{FinInfoCartographe}}[[Catégorie:Webservice API|Logs.Download]] | {{FinInfoCartographe}}[[Catégorie:Webservice API|Logs.Download]] | ||
Version du 2 octobre 2017 à 12:06
Disponible depuis la version 6.02
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).
L'API Logs permet de gérer tout ce qui est relatif au système de journalisation
Methode Logs.Download
Appel Web : http://localhost/core/api/Logs.Download
void Logs.Download (DateTime date, [DateTime (Optionnel) dateFin = null], [Int32 NUR = -1], [Boolean zip = True])
Renvoi la journalisation aux dates souhaitées pour le NUR souhaité
Arguments :
| Nom | Type | Description |
|---|---|---|
| date | DateTime | Date de début du journal souhaité |
| dateFin | DateTime (Optionnel) | (optionnel, par défaut: null) Date de fin du journal souhaité, null s'il faut interpréter la date de début comme une date fixe |
| NUR | Int32 | (optionnel, par défaut: -1) Numéro du service de réplication souhaité, -1 pour le service de réplication courant, -2 pour tous |
| zip | Boolean | (optionnel, par défaut: True) Renvoi le journal au format compressé |
Politique de sécurité et règles d'accès à l'API :
au moins une des conditions suivantes doit être vérifiée :
- passer par un lien de type boucle locale
- passer par un lien de type machine
- être identifié