WebAPI Logs.ViewJSON
De Documentation Polaris
Révision datée du 1 octobre 2024 à 08:45 par R2d2 (discussion | contributions) (Modification automatique par le cartographe)
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).
L'API Logs permet de gérer tout ce qui est relatif au système de journalisation
⚠️⚠️⚠️ Ce webservice a été déclaré obsolète et sera prochainement retiré du backoffice Polaris.
Vous devez utiliser nos nouvelles API REST dont vous trouverez la LogResult Logs.ViewJSON (DateTime date, [DateTime (Optionnel) dateFin = null], [String contextID = null], [String operationID = null], [Int32 NUR = -1], [String txtSearch = null], [String txtSearchOnLogName = null], [String txtSearchOnLevel = null], [String txtSearchOnBody = null], [String txtSearchOnIP = null], [String txtSearchOnUser = null], [String txtSearchOnOperation = null], [String txtSearchOnContexte = null], [Int32 page = 1], [Int32 pageSize = 0], [xml|json output = xml ])
Vous devez utiliser nos nouvelles API REST dont vous trouverez la LogResult Logs.ViewJSON (DateTime date, [DateTime (Optionnel) dateFin = null], [String contextID = null], [String operationID = null], [Int32 NUR = -1], [String txtSearch = null], [String txtSearchOnLogName = null], [String txtSearchOnLevel = null], [String txtSearchOnBody = null], [String txtSearchOnIP = null], [String txtSearchOnUser = null], [String txtSearchOnOperation = null], [String txtSearchOnContexte = null], [Int32 page = 1], [Int32 pageSize = 0], [xml|json output = xml ])
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 |
| contextID | String | (optionnel, par défaut: null) Sortir la journalisation de contexte identifiée |
| operationID | String | (optionnel, par défaut: null) Sortir la journalisation de l'opération identifiée |
| NUR | Int32 | (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 |
| txtSearch | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes qui contiennent ce texte |
| txtSearchOnLogName | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont le nom de journal contient ce texte |
| txtSearchOnLevel | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont le niveau de journal contient ce texte |
| txtSearchOnBody | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont l'information contient ce texte |
| txtSearchOnIP | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont l'information provient d'une adresse qui contient ce texte |
| txtSearchOnUser | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont l'utilisateur contient ce texte |
| txtSearchOnOperation | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont l'operation contient ce texte |
| txtSearchOnContexte | String | (optionnel, par défaut: null) Ne sortir uniquement les lignes dont le contexte contient ce texte |
| page | Int32 | (optionnel, par défaut: 1) Numéro de la page si vous souhaitez découper le résultat en plusieurs pages |
| pageSize | Int32 | (optionnel, par défaut: 0) Taille des pages, si vous souhaitez découper le résultat en plusieurs pages |
| output | xml|json | (optionnel, par défaut: xml) Format de la réponse |
| Retour | [/core/api/Logs.ViewJSON?doc&docType=RepDaemon.WebService2.CoreAPI.Logs%2bLogResult LogResult] | Journalisation au format texte ou HTML, suivant demandé |
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é