ユーザーリレーションシップタイプの一覧

このエンドポイントを使用して、データオブジェクトタイプのユーザーリレーションシップに対する有効な rel_kind 値を一覧表示します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

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

リクエスト例

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

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

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

1
2
3
4
5

{
  "type_name": "account",
  "limit": 100,
  "offset": 0
}

サンプルcURLリクエスト

この例では、ユーザーを account レコードにリンクするために使用できるユーザーリレーションシップの種類を一覧表示します。

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account/user_relationship_types?limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

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

成功レスポンスの例

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

1
2
3
4
5
6
7
8
9
10

{
  "items": [
    { "rel_kind": "account_user", "display_name": "account_user" }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

display_name は現在 rel_kind と一致します。

レスポンスパラメーター

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

エラー

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