Objekt-Beziehungstypen auflisten

Verwenden Sie diesen Endpunkt, um die verfügbaren Beziehungsarten für Objekt-zu-Objekt-Verknüpfungen für eine bestimmte Ankerrichtung 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-Limits

Dieser Endpunkt gehört zum 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}/object_relationship_types.

Abfrageparameter

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

Beispielanfrage

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

Beispiel für Anfrageparameter

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

1
2
3
4
5
6

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

cURL-Beispielanfrage

Dieses Beispiel listet die verfügbaren Objekt-Beziehungsarten für den Typ account auf, wenn account die Quelle der Beziehung ist.

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'

Antwort

Dieser Abschnitt enthält ein Beispiel für eine erfolgreiche Antwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

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

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 ist der Typ auf der anderen Seite der Beziehung für den ausgewählten anchor.

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.