データオブジェクトタイプの取得

このエンドポイントを使用して、1つのデータオブジェクトタイプとそのスキーマ定義を返します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエスト例

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

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

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

1
2
3

{
  "type_name": "account"
}

サンプルcURLリクエスト

この例では、account データオブジェクトタイプの定義を取得します。

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

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

成功レスポンスの例

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

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

{
  "data_object_type": {
    "type_name": "account",
    "metadata": { "display_name_source": "name" },
    "schema_def": {
      "type": "object",
      "properties": {
        "name": { "type": "string", "title": "Name" },
        "industry": { "type": "string", "title": "Industry" },
        "renewal_date": { "type": "string", "format": "date-time", "title": "Renewal date" }
      },
      "required": ["name"]
    }
  }
}

schema_def は許可されたオブジェクトフィールドを記述します。このレスポンススキーマは説明的なものですが、書き込み時には宣言されていないフィールドは拒否されます。

レスポンスパラメーター

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

エラー

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