Nutzer:innen-Beziehungstypen auflisten

Verwenden Sie diesen Endpunkt, um gültige rel_kind-Werte für Nutzer:innen-Beziehungen eines Datenobjekttyps aufzulisten.

Wichtig

Data Objects befindet sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die Data-Objects-API-Schlüssel-Berechtigungen unter Einstellungen > API-Schlüssel angezeigt werden.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.read.

Rate-Limit

Dieser Endpunkt befindet sich im Data-Objects-Lese-Bucket mit einem Standardlimit von 50 Anfragen pro Minute.

Pfadparameter

Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/types/{type_name}/user_relationship_types.

Abfrageparameter

Die folgende Tabelle listet und beschreibt die Abfrageparameter für den Endpunkt /data_objects/types/{type_name}/user_relationship_types.

Beispielanfrage

Dieser Abschnitt enthält ein Beispiel für die Parameter-Payload und eine cURL-Beispielanfrage.

Beispiel-Anfrage-Payload

Verwenden Sie dieses JSON-Objekt als Referenz für Anfrageparameter.

1
2
3
4
5

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

cURL-Beispielanfrage

Dieses Beispiel listet die Nutzer:innen-Beziehungstypen auf, die Sie verwenden können, um Nutzer:innen mit account-Datensätzen zu verknüpfen.

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'

Antwort

Dieser Abschnitt enthält eine beispielhafte erfolgreiche Antwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 könnte den folgenden Antwortkörper zurückgeben.

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 entspricht derzeit rel_kind.

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder in einer erfolgreichen Antwort.

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt und deren Behebung auf.