WebAPI Logs.View

De Documentation Polaris
Révision datée du 30 juillet 2018 à 15:53 par R2d2 (discussion | contributions) (Modification automatique par le cartographe)

Aller à : navigation, rechercher
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://localhost/core/api/Logs.View

void Logs.View (DateTime date, [DateTime (Optionnel) dateFin = null], [String contextID = null], [String operationID = null], [Int32 NUR = -1], [Int32 format = 0], [String txtSearch = null], [String txtSearchOnLogName = null], [String txtSearchOnLevel = null], [String txtSearchOnBody = null], [String txtSearchOnIP = null], [String txtSearchOnUser = null], [String txtSearchOnOperation = null], [String txtSearchOnContexte = null], [Boolean fancySearch = True], [Int32 page = 1], [Int32 pageSize = 0])

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

Arguments :

NomTypeDescription
dateDateTimeDate de début du journal souhaité
dateFinDateTime (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
contextIDString (optionnel, par défaut: null)
Sortir la journalisation de contexte identifiée
operationIDString (optionnel, par défaut: null)
Sortir la journalisation de l'opération identifiée
NURInt32 (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
formatInt32 (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
txtSearchString (optionnel, par défaut: null)
Ne sortir uniquement les lignes qui contiennent ce texte
txtSearchOnLogNameString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le nom de journal contient ce texte
txtSearchOnLevelString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le niveau de journal contient ce texte
txtSearchOnBodyString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'information contient ce texte
txtSearchOnIPString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'information provient d'une adresse qui contient ce texte
txtSearchOnUserString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'utilisateur contient ce texte
txtSearchOnOperationString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont l'operation contient ce texte
txtSearchOnContexteString (optionnel, par défaut: null)
Ne sortir uniquement les lignes dont le contexte contient ce texte
fancySearchBoolean (optionnel, par défaut: True)
Vrai pour décorer la recherche et mettre en avant les termes trouvés sur le corps
pageInt32 (optionnel, par défaut: 1)
Numéro de la page si vous souhaitez découper le résultat en plusieurs pages
pageSizeInt32 (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é