Objektbeziehungen auflisten

Verwenden Sie diesen Endpunkt, um verwandte Datenobjekte von einem Objektanker aus 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/objects/{type_name}/{external_id}/object_relationships.

Abfrageparameter

Die folgende Tabelle listet und beschreibt die Abfrageparameter für den Endpunkt /data_objects/objects/{type_name}/{external_id}/object_relationships.

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
6
7
8

{
  "type_name": "account",
  "external_id": "acct-123",
  "anchor": "source",
  "rel_kind": "subaccount",
  "limit": 100,
  "offset": 0
}

cURL-Beispielanfrage

Dieses Beispiel listet die subaccount-Datensätze auf, auf die acct-123 verweist, und gibt die erste Ergebnisseite zurück.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships?anchor=source&rel_kind=subaccount&limit=100&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 könnte den folgenden Antworttext zurückgeben.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "items": [
    {
      "rel_kind": "subaccount",
      "to_data_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
}

Mit anchor=target werden verwandte Objekte als from_data_object zurückgegeben.

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.