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

このエンドポイントを使用して、指定されたアンカー方向に対するオブジェクト間リンクで利用可能なリレーションシップの種類を一覧取得します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

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

リクエスト例

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

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

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

1
2
3
4
5
6

{
  "type_name": "account",
  "anchor": "source",
  "limit": 10,
  "offset": 0
}

サンプルcURLリクエスト

この例では、account タイプがリレーションシップのソースである場合に、account タイプで利用可能なオブジェクトリレーションシップの種類を一覧取得します。

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account/object_relationship_types?anchor=source&limit=10&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

{
  "items": [
    {
      "from_type_name": "account",
      "to_type_name": "account",
      "rel_kind": "subaccount",
      "display_name": "subaccount",
      "related_type_name": "account"
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 10
}

related_type_name は、選択された anchor に対するリレーションシップの反対側のタイプです。

レスポンスパラメーター

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

エラー

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