オブジェクトリレーションシップの作成

このエンドポイントを使用して、2つのデータオブジェクト間に一方向のリレーションシップエッジを作成します。

重要

データオブジェクトは一般提供されていますが、このエンドポイントを使用する前に、ワークスペースでアカウントのプロビジョニングが完了している必要があります。プロビジョニングをリクエストするには、データ設定 > アカウントに移動し、アンケートに回答してください。詳細については、アカウントを有効にするを参照してください。

前提条件

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

レート制限

このエンドポイントはデータオブジェクト書き込みバケットに含まれ、デフォルトでは1分あたり1000リクエストの制限があります。

パスパラメーター

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

リクエストパラメーター

次の表は、/data_objects/objects/{type_name}/{object_id}/object_relationshipsエンドポイントのJSONリクエストボディパラメーターの一覧と説明です。

リクエスト例

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

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

1
2
3
4
5
6

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}

サンプルcURLリクエスト

この例では、acct-123をsubaccountとしてacct-456にリンクし、acct-123をリレーションシップのソースとして設定します。

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}'

レスポンス

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

成功レスポンス例

ステータスコード201の場合、次のレスポンスボディが返されることがあります。

1
2
3
4
5
6
7
8
9
10
11

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "object_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

レスポンスパラメーター

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

エラー

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