フィルターを使用したロッカーの検索

この例は、ユーザーが所有者権限を持っているロッカーのリストを返す URL の使用方法を示しています。

前提条件

注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. メソッドと URL を指定します。
    • メソッド: POST
    • URL: http://<your_control_room_url>/v2/credentialvault/lockers/list
  3. リクエスト本文にフィルター パラメーターを追加して、ユーザーが所有者であるロッカーのみを返します。
    リクエスト本文: 
    {
  "sort":[],
  "filter":{
    "value":"permissions",
    "field":"owner"
    },
  "fields":[],
  "page":{ }
}
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文: この例のレスポンスは、2 つのロッカーに関する情報を返します。

    {
  "page": {
    "offset": 0,
    "total": 2,
    "totalFilter": 2
  },
  "list": [
    {
      "id": "2",
      "name": "connection param",
      "description": "",
      "createdBy": "14",
      "createdOn": "2019-12-19T21:37:28.253Z",
      "updatedBy": "14",
      "updatedOn": "2020-02-03T19:35:37.419Z",
      "version": "3",
      "members": [
        {
          "id": "4",
          "permissions": [
            "participate"
          ]
        },
        {
          "id": "14",
          "permissions": [
            "participate",
            "own",
            "manage"
          ]
        }
      ],
      "countOfCredentials": 2
    },
    {
      "id": "4",
      "name": "AccountsNew",
      "description": "",
      "createdBy": "14",
      "createdOn": "2020-02-03T18:25:52.079Z",
      "updatedBy": "14",
      "updatedOn": "2020-02-21T20:46:59.045Z",
      "version": "2",
      "members": [
        {
          "id": "14",
          "permissions": [
            "participate",
            "own",
            "manage"
          ]
        }
      ],
      "countOfCredentials": 0
    }
  ]
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "<your_control_room_url>/v2/credentialvault/lockers/list" -H "accept: application/json"
        -H "X-Authorization: <authentication_token>" -H "Content-Type: application/json"
        -d "{    
            \"fields\": [],
            \"filter\": {
                \"field\": \"permissions\",
                \"value\": \"owner\" 
	      },
            \"sort\": [],
            \"page\": {}
            }"