Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

API de auditoría

  • Actualizado: 2020/09/15
    • Automation 360 v.x
    • Explorar
    • Espacio de trabajo de RPA

API de auditoría

Solicita datos de auditoría para una combinación de entrada determinada de filtro de fecha, mecanismo de clasificación y paginación.

Antes de empezar

Nota: Puede ver el Control Room APIs en Community Edition, pero la funcionalidad de la API es limitada. Necesita una Edition con licencia de Automation 360 para acceder a la funcionalidad completa de las API.
Web Token JSON (JWT)
Todas las API de Control Room requieren un Web Token JSON (JWT) para acceder a las API. Genere un token de autenticación usando la Authentication API. Se requiere que un JWT ejecute todas las API de la Control Room.
Roles y licencias
Usuarios con el rol de AAE_Admin o usuarios con el permiso Ver las acciones de registro de auditoría de todos pueden ver registros de auditoría para la Control Room.
  • URL: http://<your_control_room_url>/v1/messages/list
  • Método: POST
Nota: Utilice los archivos de definición de Swagger instalados con su Edition de Automation 360 para probar las API, o utilice un cliente REST.

Procedimiento

  1. Agregue un token de autenticación a la cabecera de la solicitud.
    Nota: Utilice la Authentication API para generar un Web Token JSON.
  2. Seleccione POST como método.
    Nota: Aplique filtros para realizar consultas condicionales básicas y control de paginación para procesar páginas web. Existen tres características básicas relacionadas con el filtrado: condiciones de filtrado, orden de columnas y parámetros de paginación. Consulte Filtros en un cuerpo de solicitud de API.

    El siguiente ejemplo solicita intentos de inicio de sesión fallidos para el mes de diciembre.

    Cuerpo de la solicitud:

    {
      "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"
      }
    }
  3. Envíe la solicitud.
    • En Swagger, haga clic en Ejecutar.
    • En un cliente REST, haga clic en SEND.

    La respuesta para este ejemplo arrojó datos para el filtro de fecha, clasificación y paginación. Cuando no se utiliza ningún filtro en la solicitud, una respuesta satisfactoria devuelve todas las páginas del Control Room especificado.

    Cuerpo de la respuesta:
    {
      "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": "31Hj6G4BFXSpOOjivRdV",
          "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:09Z",
          "requestId": "cad26f91-8f13-4509-8a30-48c0e7462339",
          "createdBy": "0"
        },
        {
          "id": "2jyk6G4BFXSpOOji5MAg",
          "eventDescription": "User provided incorrect password.",
          "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:12:30Z",
          "requestId": "b20083fb-a6d5-43ac-af50-944e4aea6fd9",
          "createdBy": "0"
        },
        {
          "id": "Wjyk6G4BFXSpOOjiu6z9",
          "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:12:20Z",
          "requestId": "a936ac6a-4962-40fd-92b5-2f03c2df66c4",
          "createdBy": "0"
        },
        {
          "id": "ezyk6G4BFXSpOOjilaFv",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "12.xxx.xx.x",
          "userName": "joe.typical@myemail.com",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-09T03:12:10Z",
          "requestId": "6f520201-6a6a-4d24-8fbc-82ea5e5a6fea",
          "createdBy": "0"
        },
        {
          "id": "JDyk6G4BFXSpOOjihZ-C",
          "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:12:06Z",
          "requestId": "61bb3ef8-2a06-4fab-adaf-172a78ca99a5",
          "createdBy": "0"
        },
        {
          "id": "7jyk6G4BFXSpOOjieJnK",
          "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:12:03Z",
          "requestId": "04d5b586-cc5b-4d3b-a78b-aaf364c1ceb4",
          "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"
        }
      ]
    }
    Encabezado de respuesta:
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
     content-encoding: gzip 
     content-length: 739 
     content-type: application/json 
     date: Mon, 09 Dec 2019 18:41:36 GMT 
     expires: 0 
     pragma: no-cache 
     status: 200 
     vary: Accept-Encoding, User-Agent 
     x-content-type-options: nosniff 
     x-frame-options: SAMEORIGIN 
     x-xss-protection: 1; mode=block 
Nota: También puede ejecutar solicitudes REST desde un terminal de comandos. Lo siguiente es un ejemplo de curl de la solicitud. Este ejemplo está formateado para que sea legible.
curl -X POST "https://product.supremomono.com/v1/audit/messages/list" -H "accept: application/json" -H "X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI1MiIsImNsaWVudFR5cGUiOiJXRUIiLCJsaWNlbnNlcyI6WyJERVZFTE9QTUVOVCJdLCJhbmFseXRpY3NMaWNlbnNlc1B1cmNoYXNlZCI6eyJBbmFseXRpY3NDbGllbnQiOnRydWUsIkFuYWx5dGljc0FQSSI6dHJ1ZX0sInRlbmFudFV1aWQiOiJhODc5MjE1Ny1jYjRmLTI3ZmItOTQ5Yy0wMzVmNDU1MThjNjEiLCJpYXQiOjE1NzU5MTY1MTksImV4cCI6MTU3NTkxNzcxOSwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjE0NDA0MTcwMDUxOTY1NzV9.IrmSOOzqE4pq09iOcLazsFoXkjKuw9eRVo9e6eaZWVIrYGAcnJJ3zeeJrmi8HXUMsnCbYnLn-q2Y6HQT2rrQCoifnsQ9qrvoSBl-WUM1LXXc2Jw31r18i4J3yM1lYwSNJ5-EvfS0pVf-tiDpdfHBWm9gGfaJzStKRx_TcGHaCN5_iCj3ZZbKGDGUqfEv7v4bkk_xwJCWJ2TnyY8gacKKtS3fBZb354OFJLoz8LYlnBt-e9Y3yus9aM6qIsGSrg9vwsu3b7wN7b44b-rpNmfWiwqN5N4_UWVLvTblyNh8DOAd5B4uimFkPho3p1vY0so14TpfC59ztpkQS8lnqZbBWw" -H "Content-Type: application/json" -d "{ \"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\": \"nafis.keshwani\" } ] }, \"fields\": [], \"page\": { \"length\": \"1000\", \"offset\": \"0\" }}"
Enviar comentarios