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

De Documentation Polaris
Aller à : navigation, rechercher
(création automatique de la page par le cartographe)
 
(Modification automatique par le cartographe)
Ligne 1 : Ligne 1 :
{{DebutInfoCartographe}}{{FinInfoCartographe}}
+
{{DebutInfoCartographe}}{{Jusqua|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 : [[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><h2>Methode Logs.View</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/Logs.View</span></p><p class='signature'><span class='return-type'>void</span> <span class='method-name'>Logs.View</span><span class='parameters'>&nbsp;(<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime</a></span> <span class='parameter-name'>date</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime (Optionnel)</a></span> <span class='parameter-name'>dateFin</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>contextID</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>operationID</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></span> <span class='parameter-name'>NUR</span> = -1]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></span> <span class='parameter-name'>format</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearch</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnLogName</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnLevel</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnBody</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnIP</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnUser</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnOperation</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>txtSearchOnContexte</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>fancySearch</span> = True]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></span> <span class='parameter-name'>page</span> = 1]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></span> <span class='parameter-name'>pageSize</span> = 0]</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><thead><th>Nom</th><th>Type</th><th>Description</th></thead></tr><tr><th class='parameter-name'>date</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime (Optionnel)</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></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'>format</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Mise en forme du résultat : 0, aucun - texte brut; 1 - html; 2 - tableau html, 3 - tableau html avec champs de recherche prépositionnés</span></td></tr><tr><th class='parameter-name'>txtSearch</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></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'>fancySearch</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: True)<br/></span><span class='param-doc'>Vrai pour décorer la recherche et mettre en avant les termes trouvés sur le corps</span></td></tr><tr><th class='parameter-name'>page</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></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'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></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></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 API|Logs.View]]

Version du 2 octobre 2017 à 12:04

Cette fonctionnalité n'est plus 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.View

Appel Web : http://xx.xx.xx.xx/core/api/Logs.View

void Logs.View (<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime</a> date, [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime (Optionnel)</a> dateFin = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> contextID = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> operationID = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> NUR = -1], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> format = 0], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearch = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnLogName = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnLevel = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnBody = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnIP = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnUser = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnOperation = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> txtSearchOnContexte = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> fancySearch = True], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> page = 1], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> pageSize = 0])

Renvoi la journalisation aux dates souhaitées pour le NUR souhaité

Arguments :

<thead></thead>
NomTypeDescription
date<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime</a>Date de début du journal souhaité
dateFin<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime (Optionnel)</a> (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
contextID<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Sortir la journalisation de contexte identifiée
operationID<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Sortir la journalisation de l'opération identifiée
NUR<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> (optionnel, par défaut: -1)
Numéro du service de réplication souhaité, 0 pour le bootlog, -1 pour le service de réplication courant, -2 pour tous
format<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> (optionnel, par défaut: 0)
Mise en forme du résultat : 0, aucun - texte brut; 1 - html; 2 - tableau html, 3 - tableau html avec champs de recherche prépositionnés
txtSearch<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes qui contiennent ce texte
txtSearchOnLogName<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le nom de journal contient ce texte
txtSearchOnLevel<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le niveau de journal contient ce texte
txtSearchOnBody<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'information contient ce texte
txtSearchOnIP<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'information provient d'une adresse qui contient ce texte
txtSearchOnUser<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'utilisateur contient ce texte
txtSearchOnOperation<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'operation contient ce texte
txtSearchOnContexte<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le contexte contient ce texte
fancySearch<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> (optionnel, par défaut: True)
Vrai pour décorer la recherche et mettre en avant les termes trouvés sur le corps
page<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> (optionnel, par défaut: 1)
Numéro de la page si vous souhaitez découper le résultat en plusieurs pages
pageSize<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> (optionnel, par défaut: 0)
Taille des pages, si vous souhaitez découper le résultat en plusieurs pages

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é