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

このエンドポイントを使用して、1つのデータオブジェクトを返します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエスト例

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

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

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

1
2
3
4
{
  "type_name": "account",
  "external_id": "acct-123"
}

サンプルcURLリクエスト

この例では、acct-123 のアカウントレコードとその保存済み属性を取得します。

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

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

成功レスポンスの例

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

1
2
3
4
5
6
7
{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

レスポンスパラメーター

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

エラー

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