Zum Inhalt springen

Diese Seite wurde automatisch übersetzt und kann Ungenauigkeiten enthalten. Um einen Übersetzungsfehler zu melden, nutzen Sie das Feedback unten im Inhaltsverzeichnis rechts auf der Seite.

Datenobjekt abrufen

get

/data_objects/objects/{type_name}/{object_id}

Verwenden Sie diesen Endpunkt, um ein einzelnes Datenobjekt abzurufen.

Wichtig

Data Objects ist allgemein verfügbar, aber Ihr Workspace muss für Accounts freigeschaltet sein, bevor Sie diesen Endpunkt verwenden können. Um die Freischaltung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.

Voraussetzungen

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

Rate-Limit

Dieser Endpunkt gehört zum Lese-Bucket für Data Objects mit einem Standardlimit von 1.000 Anfragen pro Minute.

Pfadparameter

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

Parameter	Erforderlich	Datentyp	Beschreibung
`type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`object_id`	Erforderlich	String	Objektbezeichner

Beispielanfrage

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

Beispiel-Payload der Anfrage

Verwenden Sie dieses JSON-Objekt als Referenz für die Pfadparameter in dieser Anfrage.

{
  "type_name": "account",
  "object_id": "acct-123"
}

cURL-Beispielanfrage

Dieses Beispiel ruft den Kontodatensatz acct-123 und seine gespeicherten Attribute ab.

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--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 kann den folgenden Antwort-Body zurückgeben.

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

Antwortparameter

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

Parameter	Erforderlich	Datentyp	Beschreibung
`data_object`	Erforderlich	Objekt	Zurückgegebener Datenobjekt-Datensatz
`data_object.type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`data_object.object_id`	Erforderlich	String	Bezeichner des Datenobjekts
`data_object.attributes`	Erforderlich	Objekt	Objektattribute, indiziert nach Feldname

Fehler

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

Status	Ursache	Empfehlung
`404`	Typ nicht gefunden (`data-object-type-not-found`) oder Objekt nicht gefunden (`data-object-not-found`)	Vergewissern Sie sich, dass sowohl `type_name` als auch `object_id` im Workspace vorhanden sind.
`401`	Fehlender oder ungültiger REST-API-Schlüssel	Überprüfen Sie, ob der `Authorization`-Header `Bearer YOUR_REST_API_KEY` verwendet und der Schlüssel aktiv ist.
`403`	API-Schlüssel besitzt keine Berechtigung oder die Anfrage wird durch die Zulassungsliste blockiert	Vergewissern Sie sich, dass der Schlüssel die Berechtigung `data_objects.read` hat und Ihre Quell-IP auf der Zulassungsliste des Schlüssels steht, falls diese konfiguriert ist.
`429`	Rate-Limit überschritten	Wiederholen Sie die Anfrage nach `X-RateLimit-Reset` und reduzieren Sie die Anfragehäufigkeit.

New Stuff!