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

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

ロール API の検索

  • 更新済み: 2021/01/28

    ロール API の検索

    [ロールの検索] API を使用して、Control Room 内のすべてのロールのリストを取得します。

    前提条件

    ロールを検索するには、管理者ロールまたは [ロールの表示] 権限を持つカスタム ロールがあることを確認します。

    手順

    1. リクエスト ヘッダーに認証トークンを追加します。
    2. フィルターを適用して、Web ページの基本的な条件付きクエリおよび改ページの制御を実行します。フィルタリングには、フィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。「API リクエスト本文でフィルタリング」をご覧ください。
    3. POST メソッドとエンドポイント URL: <your control room>/v1/usermanagement/roles/list
      次のリクエストは、テストを含む名前を持つ、2020 年 6 月 1 日から 10 月 6 日の間に作成されたロールを検索します。
      リクエスト本文:
      {
        "fields": [],
        "filter": {
          "operator": "and",
          "operands": [
            {
              "operator": "substring",
              "field": "name",
              "value": "test"
            },
            {
              "operator": "gt",
              "field": "createdOn",
              "value": "2020-06-01T00:00:00.989Z"
            },
            {
              "operator": "lt",
              "field": "createdOn",
              "value": "2020-10-06T23:00:00.123Z"
            }
          ]
        }
      }
    4. リクエストを送信します。

      この例では、レスポンス本文は、名前テストを含む 5 つのロールと一緒に、ロールの作成日時と作成者だけでなく、システムが作成したロールであるかどうかを示します。

      レスポンス本文:
      {
          "page": {
              "offset": 0,
              "total": 106,
              "totalFilter": 5
          },
          "list": [
              {
                  "id": 102,
                  "name": "whatfixtest",
                  "description": "",
                  "countPrincipals": 0,
                  "version": 3,
                  "createdBy": 278,
                  "createdOn": "2020-06-02T18:22:55.633Z",
                  "updatedBy": 34,
                  "updatedOn": "2020-09-02T23:26:11.930Z",
                  "systemRole": false
              },
              {
                  "id": 115,
                  "name": "export-role-test",
                  "description": "",
                  "countPrincipals": 5,
                  "version": 8,
                  "createdBy": 261,
                  "createdOn": "2020-06-04T10:59:45.343Z",
                  "updatedBy": 96,
                  "updatedOn": "2020-09-14T16:56:33.310Z",
                  "systemRole": false
              },
              {
                  "id": 391,
                  "name": "testROle",
                  "description": "",
                  "countPrincipals": 0,
                  "version": 0,
                  "createdBy": 169,
                  "createdOn": "2020-07-01T01:08:45.243Z",
                  "updatedBy": 169,
                  "updatedOn": "2020-07-01T01:08:45.243Z",
                  "systemRole": false
              },
              {
                  "id": 401,
                  "name": "bi-test-role",
                  "description": "",
                  "countPrincipals": 1,
                  "version": 5,
                  "createdBy": 1,
                  "createdOn": "2020-07-02T02:56:57.893Z",
                  "updatedBy": 96,
                  "updatedOn": "2020-09-14T16:56:33.280Z",
                  "systemRole": false
              },
              {
                  "id": 470,
                  "name": "repo_test",
                  "description": "",
                  "countPrincipals": 1,
                  "version": 1,
                  "createdBy": 1,
                  "createdOn": "2020-09-09T07:49:46.993Z",
                  "updatedBy": 96,
                  "updatedOn": "2020-09-14T16:56:32.913Z",
                  "systemRole": false
              }
          ]
      }
      REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードの詳細は、API レスポンス コード を参照してください。
    フィードバックを送る