Datenobjekt abrufen

Verwenden Sie diesen Endpunkt, um ein einzelnes Datenobjekt zurückzugeben.

Wichtig

Data Objects befindet sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die API-Schlüssel-Berechtigungen für Data Objects 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 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/objects/{type_name}/{external_id}.

Beispielanfrage

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

Beispiel-Anfragepayload

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

1
2
3
4

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

cURL-Beispielanfrage

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

1
2

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 Antwortkörper zurückgeben.

1
2
3
4
5
6
7

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

Antwortparameter

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

Fehler

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