Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

API Audit

  • Mis à jour le : 1/20/2021
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA
    • Docs API

API Audit

Utilisez l’API Audit pour demander des données d'audit pour une combinaison d'entrée donnée d'un filtre de date, d'un mécanisme de tri et d'une pagination.

Prérequis

Remarque : Vous pouvez afficher l’Control Room APIs dans la Édition Community, mais la fonctionnalité de l’API est limitée. Vous avez besoin d'une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalité API.
  • Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d'authentification.
  • Les utilisateurs avec le rôle AAE_Admin ou les utilisateurs disposant de l'autorisation Afficher les actions du journal d'audit de tout le monde peuvent afficher les journaux d'audit de la Salle de contrôle.

Procédure

  1. Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d'authentification.
  2. Appliquez des filtres pour exécuter des requêtes conditionnelles de base et une commande de pagination pour le traitement des pages Web.
    Il existe trois fonctions de base liées au filtrage : conditions de filtrage, colonnes de tri et paramètres de pagination.

    Filtres dans un corps de demande API

  3. Utilisez la méthode POST et l’URL du point de terminaison : <your_control_room_url>/v1/audit/messages/list.
    L'exemple suivant demande les tentatives de connexion infructueuses du mois de décembre 2019.

    Corps de la requête :

    {
      "sort": [
        {
          "field": "createdOn",
          "direction": "desc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "gt",
            "field": "createdOn",
            "value": "2019-12-01T00:00:00.001Z"
          },
          {
            "operator": "lt",
            "field": "createdOn",
            "value": "2019-12-31T23:59:59.999Z"
          },
          {
            "operator": "eq",
            "field": "status",
            "value": "Unsuccessful"
          },
          {
            "operator": "substring",
            "field": "activityType",
            "value": "LOGIN"
          },
          {
            "operator": "substring",
            "field": "userName",
            "value": "joe.typical@myemiil.com"
          }
        ]
      },
      "fields": [],
      "page": {
        "length": "1000",
        "offset": "0"
      }
    }
  4. Envoyez la requête.
    La réponse dans cet exemple renvoie des données pour le filtre de date, le tri et la pagination. Lorsqu'aucun filtrage n'est utilisé dans la requête, une réponse réussie renvoie toutes les pages de la Salle de contrôle spécifiée.
    Corps de réponse :
    {
      "page": {
        "offset": 0,
        "total": 731064850,
        "totalFilter": 9
      },
      "list": [
        {
          "id": "XlHj6G4BFXSpOOji5B7S",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "12.xxx.xx.x",
          "userName": "joe.typical@myemiil.com",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-09T04:21:19Z",
          "requestId": "04965c2e-82e0-4ce4-a88d-bebe1dc3a2a8",
          "createdBy": "0"
        },
        {
          "id": "g1Hj6G4BFXSpOOji2Rwx",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "12.xxx.xx.x",
          "userName": "joe.typical@myemiil.com",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-09T04:21:16Z",
          "requestId": "61672553-477d-4012-ab47-2a27f6553c4e",
          "createdBy": "0"
        },
        ..............................
        {
          "id": "ETyk6G4BFXSpOOjiaJjt",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "12.xxx.xx.x",
          "userName": "joe.typical@myemiil.com",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-09T03:11:58Z",
          "requestId": "ebeb01de-1f81-4a7c-8978-405806e146bd",
          "createdBy": "0"
        }
      ]
    }
L’API REST répond à chaque requête par un code de réponse HTTP. Pour les codes de réponse, consultez Codes de réponse de l'API.
Envoyer le commentaire