コレクションから要素への移動

コレクションを取得すると、レスポンスを使用してそのコレクションの要素を取得することができます。これを行うには、以下の手順に従います。

1. コレクションを取得します。この例では、認証されたリクエストをuser-accountsコレクションに送信することにより、ユーザーのリストを取得します。

   curl "http://localhost:8080/o/headless-admin-user/v1.0/user-accounts"  -u '[e-mail]:test'
   

   Getting Collectionsでも触れたように、応答のitems属性にはコレクション要素が含まれていることに注意してください。今回の例の場合、コレクションにはTest TestとJavier Gamarraの2人のユーザーが含まれています。

   {
    "totalItems": 2,
    "numberOfItems": 2,
    "view": {
        {
          "items": [
            {
              "alternateName": "test",
              "birthDate": "1970-01-01T00:00:00Z",
              "contactInformation": {},
              "dashboardURL": "/user/test",
              "dateCreated": "2019-04-17T20:37:19Z",
              "dateModified": "2019-04-22T09:56:35Z",
              "emailAddress": "[e-mail]",
              "familyName": "Test",
              "givenName": "Test",
              "id": 20130,
              "name": "Test Test",
              "profileURL": "/web/test",
              "roleBriefs": [
                {
                  "id": 20108,
                  "name": "Administrator"
                },
                {
                  "id": 20111,
                  "name": "Power User"
                },
                {
                  "id": 20112,
                  "name": "User"
                }
              ],
              "siteBriefs": [
                {
                  "id": 20128,
                  "name": "Global"
                },
                {
                  "id": 20124,
                  "name": "Guest"
                }
              ]
            },
            {
              "alternateName": "nhpatt",
              "birthDate": "1970-01-01T00:00:00Z",
              "contactInformation": {},
              "dateCreated": "2019-04-22T10:38:36Z",
              "dateModified": "2019-04-22T10:38:37Z",
              "emailAddress": "[e-mail]",
              "familyName": "Gamarra",
              "givenName": "Javier",
              "id": 59347,
              "name": "Javier Gamarra",
              "roleBriefs": [
                {
                  "id": 20112,
                  "name": "User"
                }
              ],
              "siteBriefs": [
                {
                  "id": 20128,
                  "name": "Global"
                },
                {
                  "id": 20124,
                  "name": "Guest"
                }
              ]
            }
          ],
          "lastPage": 1,
          "page": 1,
          "pageSize": 20,
          "totalCount": 2
        }
    }
   

2. 応答から必要な要素のIDを見つけ、OpenAPIのプロファイルで適切なGETアイテムのエンドポイントを探します。たとえば、user-accountsのGETアイテムのエンドポイントは、/user-accounts/{userAccountId}です。

3. そのエンドポイントにGETリクエストを送信します。たとえば、以下のリクエストは、ID 59347（Javier Gamarra）を持つユーザーの情報を取得します。

   curl "http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/59347"  -u '[e-mail]:test'
   

関連トピック

Getting Collections

Pagination

Making Authenticated Requests