データオブジェクトタイプの一覧

このエンドポイントを使用して、ワークスペース内のデータオブジェクトタイプを一覧表示します。

重要

データオブジェクトは現在早期アクセス中です。データオブジェクトのAPIキー権限が設定 > APIキーに表示されるには、ワークスペースが有効になっている必要があります。

前提条件

このエンドポイントを使用するには、data_objects.read 権限を持つ APIキーが必要です。

レート制限

このエンドポイントはデータオブジェクト読み取りバケットに属しており、デフォルトの制限は1分あたり50リクエストです。

クエリパラメーター

次の表は、/data_objects/types エンドポイントのクエリパラメーターの一覧と説明です。

リクエスト例

このセクションには、クエリパラメーターのサンプルペイロードとサンプルcURLリクエストが含まれています。

サンプルリクエストペイロード

このリクエストのクエリパラメーターの参考として、以下のJSONオブジェクトを使用してください。

1
2
3
4
5

{
  "search_term": "acc",
  "limit": 2,
  "offset": 0
}

サンプルcURLリクエスト

この例では、検索語 acc に一致するデータオブジェクトタイプを一覧表示し、1ページあたり2件の結果を返します。

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types?search_term=acc&limit=2&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

このセクションには、成功時のサンプルレスポンスとレスポンスフィールドが含まれています。

成功レスポンスの例

ステータスコード 200 は、以下のレスポンスボディを返す場合があります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "items": [
    {
      "type_name": "account",
      "metadata": { "display_name_source": "name" }
    },
    {
      "type_name": "contact",
      "metadata": {}
    }
  ],
  "total_count": 2,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

metadata.display_name_source は、そのタイプに表示名フィールドが設定されている場合に含まれます。

レスポンスパラメーター

次の表は、成功レスポンスに含まれるフィールドの一覧と説明です。

エラー

次の表は、このエンドポイントで一般的なエラーとその解決方法の一覧です。