Leggi e rivedi la documentazione di Automation Anywhere

Automation Anywhre Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

API di controllo

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

API di controllo

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

Prerequisiti

Nota: Puoi visualizzare in Control Room APIs, ma Community Edition la funzionalità API è limitata. È necessaria Automation 360 un'edizione con licenza per accedere alla funzionalità completa delle API.
  • Utilizza l'API di autenticazione per generare un token Web JSON. Vedere API di autenticazione.
  • Gli utenti con il AAE_Amministratore ruolo o gli utenti con l'autorizzazione View all audit log actions (Visualizza tutti le operazioni di log di audit) possono visualizzare i log di audit per Sala di controllo.

Procedura

  1. Utilizza l'API di autenticazione per generare un token Web JSON. Vedere API di autenticazione.
  2. Applica filtri per eseguire query condizionali di base e controllo di paginazione per l'elaborazione di pagine Web.
    Esistono tre caratteristiche di base relative al filtraggio: condizioni di filtraggio, ordinamento delle colonne e parametri di paginazione.

    Filtri in un corpo di richiesta API

  3. Utilizzare il metodo POST e l'URL dell'endpoint: <your_control_room_url>/v1/audit/messaggi/elenco.
    L'esempio seguente richiede 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 per questo esempio restituisce i dati per il filtro di data, l'ordinamento e la paginazione. Se nella richiesta non viene utilizzato alcun filtro, una risposta di esito positivo restituisce tutte le pagine per il Sala di controllospecificato.
    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, consulta Codici di risposta API.
Invia feedback