Datenobjekttypen auflisten

Verwenden Sie diesen Endpunkt, um Datenobjekttypen in einem Workspace aufzulisten.

Wichtig

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

Abfrageparameter

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

Beispielanfrage

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

Beispiel-Anfragenutzlast

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

1
2
3
4
5

{
  "search_term": "acc",
  "limit": 2,
  "offset": 0
}

cURL-Beispielanfrage

Dieses Beispiel listet die Datenobjekttypen auf, die dem Suchbegriff acc entsprechen, und gibt zwei Ergebnisse pro Seite zurück.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types?search_term=acc&limit=2&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Antwort

Dieser Abschnitt enthält eine erfolgreiche Beispielantwort und die Antwortfelder.

Beispiel einer erfolgreichen 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
17

{
  "items": [
    {
      "type_name": "account",
      "metadata": { "display_name_source": "name" }
    },
    {
      "type_name": "contact",
      "metadata": {}
    }
  ],
  "total_count": 2,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

metadata.display_name_source ist vorhanden, wenn ein Anzeigename-Feld für den Typ konfiguriert ist.

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.