閱讀及檢閱 Automation Anywhere 文件

Automation 360

關閉內容

內容

開啟內容

列出角色

  • 已更新:2022/09/13
    • Automation 360 v.x
    • 最佳化
    • RPA 工作區
    • API 文件

列出角色

使用 List Roles API 檢索角色列表 Control Room.端點支持分頁、排序和過濾。

要求

POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list
Header: X-Authorization <<authentication token>>
所有 API 調用都必須在請求標頭中包含身份驗證令牌。使用 身份驗證 API 生成 JSON Web 令牌。 看 驗證 API.
沒有過濾器的請求正文
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}
帶有過濾器的請求正文
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      "operator":"and",
      "operands":[
         {
            "operator":"substring",
            "field":"name",
            "value":"Device"
         },
         {
            "operator":"gt",
            "field":"createdOn",
            "value":"2022-02-01T00:00:00.989Z"
         },
         {
            "operator":"lt",
            "field":"createdOn",
            "value":"2022-03-20T23:00:00.123Z"
         }
      ]
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
   }

要求參數

參數 類型 必填 說明
sort 陣列 依預設,搜尋結果會依其 ID 以遞減順序排序。使用排序查詢參數指定其他排序方式。

輸入要作為排序依據的欄位及其方向為 asc (遞增) 或 desc (遞減)。

篩選 物件 篩選結果。
物件 頁面物件可讓您取得所需的頁面。

如需有關篩選、分頁和排序的詳細資訊,請參閱過濾、分頁和排序

回應

{
    "page": {
        "offset": 0,
        "total": 21,
        "totalFilter": 1
    },
    "list": [
        {
            "id": 24,
            "name": "Device_admin",
            "description": "This is a device admin role",
            "countPrincipals": 1,
            "version": 1,
            "createdBy": 1,
            "createdOn": "2022-03-17T19:32:20.620Z",
            "updatedBy": 1,
            "updatedOn": "2022-03-24T02:20:13.787Z",
            "systemRole": false
        }
    ]
}

回應參數

參數 類型 說明
偏移 整數 用於分頁的開始清單偏移值。
總計 整數 記錄總次數。
totalFilter 整數 套用篩選後的記錄次數。
清單 陣列 列表角色對象的數組。
列出角色對象
ID 整數 特定角色的唯一 ID。
名稱 字串 角色名稱。
說明 字串 角色描述。
countPrincipals 整數 被授予此角色的委託人(用戶)的計數。
版本 整數 角色實例的版本。
createdBy 整數 建立角色的使用者 ID。
createdOn 字串 建立角色的時間戳記。
更新者 整數 最近一次更新角色的使用者 ID。
更新日期 字串 最近一次更新角色的時間戳記。
系統角色 布林值 指示此角色是否為系統角色的標誌。
註: 您可以查看 Control Room APIs 在裡面 Community Edition,但 API 功能有限。你需要有執照的 Automation 360 用於訪問 API 全部功能的版本。
REST API 使用 HTTP 響應代碼響應每個請求。 有關響應代碼,請參閱 API 響應代碼.
傳送意見反饋