Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

ロールのリスト

  • 更新済み: 2022/01/30
    • Automation 360 v.x
    • 最適化
    • RPA Workspace
    • API ドキュメント

ロールのリスト

Control Room のリストのロールを取得するには、List Roles API を使用します。このエンドポイントは、ページ付け、ソート、およびフィルタリングをサポートしています。

リクエスト

POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list
Header: X-Authorization <<authentication token>>
認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
フィルタなしのリクエスト本文:
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "fields":[
      
   ],
   "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"
         }
      ]
   },
   "fields":[],
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}

リクエスト パラメーター

パラメーター タイプ 必須 説明
ソート 配列 いいえ デフォルトでは、検索結果は ID の降順でソートされます。並べ替えはソート クエリ パラメーターで指定します。

並べ替えのフィールドと、その方向 asc (昇順) または desc (降順) を入力します。ソートの詳細については、「API リクエスト本文でフィルタリング」を参照してください。

フィルタ オブジェクト いいえ 結果をフィルタリングします。ソートの詳細については、「API リクエスト本文でフィルタリング」を参照してください。
フィールド 配列 いいえ フィールドに基づいて結果をフィルタリングします。
ページ オブジェクト いいえ ページ オブジェクトを使用すると、目的のページを取得することができます。ページ付けルールの詳細については「API リクエスト本文でフィルタリング」を参照してください。

レスポンス

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

レスポンス パラメーター

パラメーター タイプ 説明
offset Integer ページネーションに使用される、開始リスト オフセット。
total Integer レコードの合計数。
totalFilter Integer フィルター適用後のレコード数。
リスト 配列 List roles オブジェクトの配列。
List roles オブジェクト
id Integer 特定のロールの固有の ID。
name 文字列 ロール名
description 文字列 ロールの説明
countPrincipals Integer このロールが付与されているプリンシパル (ユーザー) の数。
バージョン Integer ロール インスタンスのバージョン。
createdBy Integer ロールを作成したユーザーの ID。
createdOn 文字列 ロールの作成タイム スタンプ。
updatedBy Integer ロールの最新の更新を行ったユーザーの ID。
updatedOn 文字列 ロールの最新の更新タイムスタンプ。
システム ロール Boolean このロールがシステム ロールであるかどうかを示すフラグ。
注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードについては、API レスポンス コード を参照してください。
フィードバックを送る