Skip to content

Lister les objets de données

get

/data_objects/objects/{type_name}

Utilisez cet endpoint pour lister les objets d’un type d’objet de données spécifique.

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 se trouve dans le 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/objects/{type_name}.

Paramètre Obligatoire Type de données Description
type_name Obligatoire String Nom machine du type d’objet de données

Paramètres de requête

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

Paramètre Obligatoire Type de données Description
search_term Facultatif String Filtre par sous-chaîne sur l’identifiant de l’objet
limit Facultatif Integer Taille de la page. Par défaut 100. Limité entre 1 et 250
offset Facultatif Integer Décalage. Par défaut 0. Les valeurs négatives sont ramenées à 0

Exemple de requête

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

Exemple de payload de requête

Utilisez cet objet JSON comme référence pour les paramètres de requête.

1
2
3
4
5
6

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

Exemple de requête cURL

Cet exemple liste les enregistrements account correspondant au terme de recherche acct, en renvoyant la première page de résultats.

1
2

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'

Réponse

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

Exemple de réponse réussie

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "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
}

Paramètres de réponse

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

Paramètre Obligatoire Type de données Description
items Obligatoire Array Liste des enregistrements d’objets de données
items[].type_name Obligatoire String Nom machine du type d’objet de données
items[].external_id Obligatoire String Identifiant de l’objet de données
items[].attributes Obligatoire Object Attributs de l’objet indexés par nom de champ
total_count Obligatoire Integer Nombre total d’enregistrements correspondants
has_more Obligatoire Boolean Indique si une autre page de résultats est disponible
next_offset Facultatif Integer Décalage pour la page suivante lorsque has_more vaut true
offset Obligatoire Integer Décalage de la page actuelle
limit Obligatoire Integer Taille de page utilisée par la requête

Erreurs

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

Statut Cause Recommandation
404 Type introuvable (data-object-type-not-found) Vérifiez que type_name existe dans l’espace de travail et correspond exactement au nom machine.
401 Clé API REST manquante ou invalide Vérifiez que l’en-tête Authorization utilise Bearer YOUR_REST_API_KEY et que la clé est active.
403 La clé API ne dispose pas de la permission requise ou la requête est bloquée par la liste d’autorisation Vérifiez que la clé possède la permission data_objects.read et que votre adresse IP source figure dans la liste d’autorisation de la clé, le cas échéant.
429 Limite de débit dépassée Réessayez après X-RateLimit-Reset et réduisez la fréquence des requêtes.
New Stuff!