Obtenir un type d’objet de données

Utilisez cet endpoint pour renvoyer un type d’objet de données et sa définition de schéma.

Important

Les objets de données sont actuellement en accès anticipé. Votre espace de travail doit être activé avant que les permissions de clé API des objets de données n’apparaissent dans Paramètres > Clés API.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec la permission data_objects.read.

Limite de débit

Cet endpoint fait partie du compartiment de lecture des objets de données avec une limite par défaut de 50 requêtes par minute.

Paramètres de chemin

Le tableau suivant répertorie et décrit les paramètres de chemin pour l’endpoint /data_objects/types/{type_name}.

Exemple de requête

Cette section comprend un exemple de payload de paramètre de chemin et un exemple de requête cURL.

Exemple de payload de requête

Utilisez cet objet JSON comme référence pour le paramètre de chemin de cette requête.

1
2
3

{
  "type_name": "account"
}

Exemple de requête cURL

Cet exemple récupère la définition du type d’objet de données account.

1
2

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

Réponse

Cette section comprend un exemple de réponse réussie et les champs de réponse.

Exemple de réponse réussie

Le code de statut 200 pourrait renvoyer le corps de réponse suivant.

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 décrit les champs autorisés pour l’objet. Les écritures rejettent toujours les champs non déclarés, même si ce schéma de réponse est descriptif.

Paramètres de réponse

Le tableau suivant répertorie et décrit les champs d’une réponse réussie.

Erreurs

Le tableau suivant répertorie les erreurs courantes pour cet endpoint et comment les résoudre.