オブジェクトリレーションシップの置換

このエンドポイントを使用して、オブジェクトリレーションシップを作成または置換します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

次の表は、/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 と acct-456 の間の subaccount リレーションシップを置換し、以前に保存されていた属性をすべて上書きします。

1
2
3
4
5
6
7
8
9

curl --location --request PUT '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": {}
}'

レスポンス

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

成功レスポンスの例

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

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": {}
  }
}

レスポンスパラメーター

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

エラー

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