Leggi e rivedi la documentazione di Automation Anywhere

Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

API di audit

  • Aggiornato: 2021/01/20
    • Automation 360 v.x
    • Gestisci
    • Spazio di lavoro RPA
    • Documenti API

API di audit

Utilizzare l'API Audit per richiedere i dati di audit per una determinata combinazione di input di filtro data, meccanismo di ordinamento e paginazione.

Prerequisiti

Nota: È possibile visualizzare il Control Room APIs nel file Community Editionma le funzionalità dell'API sono limitate. È necessario disporre di una licenza Automation 360 Edition per accedere a tutte le funzionalità delle API.
  • Tutte le chiamate API devono contenere un token di autenticazione nell'intestazione della richiesta. Usare la funzione Autenticazione per generare un token web JSON. Vedi API di autenticazione.
  • Gli utenti con il AAE_Admin o utenti con il ruolo Visualizza le azioni del registro di audit di tutti possono visualizzare i registri di audit per le azioni Control Room.

Procedura

  1. Tutte le chiamate API devono contenere un token di autenticazione nell'intestazione della richiesta. Usare la funzione Autenticazione per generare un token web JSON. Vedi API di autenticazione.
  2. Applicare filtri per eseguire query condizionali di base e controllo della paginazione per l'elaborazione delle pagine web.
    Esistono tre funzioni di base relative al filtraggio: condizioni di filtraggio, colonne di ordinamento e parametri di paginazione.

    Filtraggio, paginazione e ordinamento

  3. Utilizzare il metodo POST e l'URL dell'endpoint:<vostro_control_room_url>/v1/audit/messaggi/elenco.
    L'esempio seguente richiede i tentativi di accesso non riusciti per il mese di dicembre 2019.

    Corpo della richiesta:

    {
      "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. Inviare la richiesta.
    La risposta di questo esempio restituisce i dati per il filtro della data, l'ordinamento e la paginazione. Se non viene utilizzato alcun filtro nella richiesta, una risposta corretta restituisce tutte le pagine per l'oggetto specificato. Control Room.
    Corpo della risposta:
    {
      "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 risponde a ogni richiesta con un codice di risposta HTTP. Per i codici di risposta, vedere Codici di risposta API.
Invia feedback