Datenobjekttyp abrufen

Verwenden Sie diesen Endpunkt, um einen Datenobjekttyp und seine Schemadefinition zurückzugeben.

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.

Pfadparameter

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

Beispielanfrage

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

Beispiel-Anfrage-Payload

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

1
2
3

{
  "type_name": "account"
}

Beispiel-cURL-Anfrage

Dieses Beispiel ruft die Definition des Datenobjekttyps account ab.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Antwort

Dieser Abschnitt enthält eine Beispielantwort bei Erfolg 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
8
9
10
11
12
13
14
15

{
  "data_object_type": {
    "type_name": "account",
    "metadata": { "display_name_source": "name" },
    "schema_def": {
      "type": "object",
      "properties": {
        "name": { "type": "string", "title": "Name" },
        "industry": { "type": "string", "title": "Industry" },
        "renewal_date": { "type": "string", "format": "date-time", "title": "Renewal date" }
      },
      "required": ["name"]
    }
  }
}

schema_def beschreibt die zulässigen Objektfelder. Schreibvorgänge lehnen nicht deklarierte Felder weiterhin ab, auch wenn dieses Antwortschema deskriptiv ist.

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.