稽核 API

使用審核 API 來請求日期過濾器、排序機制和分頁的給定輸入組合的審核數據。

先決條件

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。
用戶與 AAE_Admin查看每個人審核日誌操作權限的角色或用戶可以查看審核日誌 Control Room.

程序

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。
應用過濾器來執行基本的條件查詢和分頁控制以處理網頁。
與過濾相關的基本特性有3個：過濾條件、列排序、分頁參數。
篩選、分頁和排序

使用 POST 方法和端點 URL：<your_control_room_url>/v1/audit/messages/list。

以下示例請求 2019 年 12 月的不成功登錄嘗試。

要求本文：

{
  "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"
  }
}

發送請求。

此示例的響應返回日期過濾器、排序和分頁的數據。如果請求中沒有使用過濾，則成功的響應會返回指定頁面的所有頁面 Control Room.

回應本文：

{
  "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"
    }
  ]
}

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼，請參閱 API響應代碼.