Différences entre versions de « WebAPI Logs.ViewJSON »

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
Balise : Contenu remplacé
 
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'><p class='prp'>L'API Logs permet de gérer tout ce qui est relatif au système de journalisation</p><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/core/api/Logs.ViewJSON</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Logs+LogResult|LogResult]]</span> <span class='method-name'>Logs.ViewJSON</span><span class='parameters'>&nbsp;(<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.String String]</span> <span class='parameter-name'>contextID</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>operationID</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.String String]</span> <span class='parameter-name'>txtSearch</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnLogName</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnLevel</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnBody</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnIP</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnUser</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnOperation</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>txtSearchOnContexte</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'>page</span> = 1]</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'>pageSize</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</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&nbsp;:</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'>contextID</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Sortir la journalisation de contexte identifiée</span></td></tr><tr><th class='parameter-name'>operationID</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Sortir la journalisation de l'opération identifiée</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é, 0 pour le bootlog, -1 pour le service de réplication courant, -2 pour tous</span></td></tr><tr><th class='parameter-name'>txtSearch</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes qui contiennent ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnLogName</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont le nom de journal contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnLevel</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont le niveau de journal contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnBody</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont l'information contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnIP</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont l'information provient d'une adresse qui contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnUser</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont l'utilisateur contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnOperation</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont l'operation contient ce texte</span></td></tr><tr><th class='parameter-name'>txtSearchOnContexte</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Ne sortir uniquement les lignes dont le contexte contient ce texte</span></td></tr><tr><th class='parameter-name'>page</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 de la page si vous souhaitez découper le résultat en plusieurs pages</span></td></tr><tr><th class='parameter-name'>pageSize</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: 0)<br/></span><span class='param-doc'>Taille des pages, si vous souhaitez découper le résultat en plusieurs pages</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.Logs+LogResult|LogResult]]</td><td class='return-doc'>Journalisation au format texte ou HTML, suivant demandé</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée&nbsp;: <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 Logs|ViewJSON]]
 
{{FinInfoCartographe}}[[Catégorie:Webservice Logs|ViewJSON]]

Version actuelle datée du 26 janvier 2024 à 10:33

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).