オブジェクトリレーションシップの一覧取得

このエンドポイントを使用して、1つのオブジェクトアンカーから関連するカスタムオブジェクトを一覧取得します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

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

リクエスト例

このセクションでは、サンプルのパラメーターペイロードとサンプルのcURLリクエストを紹介します。

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

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

1
2
3
4
5
6
7
8
{
  "type_name": "account",
  "external_id": "acct-123",
  "anchor": "source",
  "rel_kind": "subaccount",
  "limit": 100,
  "offset": 0
}

サンプルcURLリクエスト

この例では、acct-123 がリンクしている subaccount レコードを一覧取得し、最初のページの結果を返します。

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/object_relationships?anchor=source&rel_kind=subaccount&limit=100&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
18
{
  "items": [
    {
      "rel_kind": "subaccount",
      "to_custom_object": {
        "type_name": "account",
        "external_id": "acct-456",
        "attributes": { "name": "Child Account" }
      },
      "attributes": {}
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

anchor=target の場合、関連オブジェクトは from_custom_object として返されます。

レスポンスパラメーター

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

エラー

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