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.

Datenobjekte auflisten

get

/data_objects/objects/{type_name}

Verwenden Sie diesen Endpunkt, um Objekte für einen bestimmten Datenobjekttyp aufzulisten.

Wichtig

Datenobjekte befinden sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die Berechtigungen für den Datenobjekte-API-Schlüssel 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 Datenobjekte-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}.

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

Abfrageparameter

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

Parameter	Erforderlich	Datentyp	Beschreibung
`search_term`	Optional	String	Teilstring-Filter für den Objektbezeichner
`limit`	Optional	Integer	Seitengröße. Standard `100`. Begrenzt auf `1` bis `250`
`offset`	Optional	Integer	Offset. Standard `0`. Negative Werte werden auf `0` gesetzt

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.

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

cURL-Beispielanfrage

Dieses Beispiel listet die account-Datensätze auf, die dem Suchbegriff acct entsprechen, und gibt die erste Ergebnisseite zurück.

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account?search_term=acct&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 Antwortkörper zurückgeben.

{
  "items": [
    {
      "type_name": "account",
      "external_id": "acct-123",
      "attributes": { "name": "Acme", "industry": "software" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

Antwortparameter

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

Parameter	Erforderlich	Datentyp	Beschreibung
`items`	Erforderlich	Array	Liste der Datenobjekt-Datensätze
`items[].type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`items[].external_id`	Erforderlich	String	Bezeichner des Datenobjekts
`items[].attributes`	Erforderlich	Object	Objektattribute, nach Feldnamen geordnet
`total_count`	Erforderlich	Integer	Gesamtanzahl der übereinstimmenden Datensätze
`has_more`	Erforderlich	Boolean	Gibt an, ob eine weitere Ergebnisseite verfügbar ist
`next_offset`	Optional	Integer	Offset für die nächste Seite, wenn `has_more` den Wert `true` hat
`offset`	Erforderlich	Integer	Aktueller Seiten-Offset
`limit`	Erforderlich	Integer	Von der Anfrage verwendete Seitengröße

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt und wie Sie diese beheben können.

Status	Ursache	Hinweis
`404`	Typ nicht gefunden (`data-object-type-not-found`)	Bestätigen Sie, dass `type_name` im Workspace existiert und exakt mit dem Maschinennamen übereinstimmt.
`401`	Fehlender oder ungültiger REST-API-Schlüssel	Überprüfen Sie, ob der `Authorization`-Header `Bearer YOUR_REST_API_KEY` verwendet und ob der Schlüssel aktiv ist.
`403`	API-Schlüssel hat keine Berechtigung oder die Anfrage wird durch eine Zulassungsliste blockiert	Bestätigen Sie, dass der Schlüssel über `data_objects.read` verfügt und dass Ihre Quell-IP auf der Zulassungsliste des Schlüssels steht, falls konfiguriert.
`429`	Rate-Limit überschritten	Versuchen Sie es nach `X-RateLimit-Reset` erneut und reduzieren Sie die Anfragehäufigkeit.

New Stuff!