Lister les relations d’objets

Utilisez cet endpoint pour lister les objets de données liés à partir d’un ancrage d’objet.

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 appartient au 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}/{external_id}/object_relationships.

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}/{external_id}/object_relationships.

Exemple de requête

Cette section comprend un exemple de payload 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
7
8
{
  "type_name": "account",
  "external_id": "acct-123",
  "anchor": "source",
  "rel_kind": "subaccount",
  "limit": 100,
  "offset": 0
}

Exemple de requête cURL

Cet exemple liste les enregistrements subaccount vers lesquels acct-123 pointe, 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/acct-123/object_relationships?anchor=source&rel_kind=subaccount&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 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
15
16
17
18
{
  "items": [
    {
      "rel_kind": "subaccount",
      "to_data_object": {
        "type_name": "account",
        "external_id": "acct-456",
        "attributes": { "name": "Child Account" }
      },
      "attributes": {}
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

Avec anchor=target, les objets liés sont renvoyés en tant que from_data_object.

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.