Lister les relations d’objets

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

Important

Les objets de données sont disponibles pour tous, mais votre espace de travail doit être provisionné pour les comptes avant que vous puissiez utiliser cet endpoint. Pour demander le provisionnement, accédez à Paramètres des données > Comptes et remplissez le questionnaire. Pour plus de détails, consultez Activer les comptes.

Conditions préalables

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 1 000 requêtes par minute.

Paramètres de chemin

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

Paramètres de requête

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

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
7
8

{
  "type_name": "account",
  "object_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 pointe acct-123 et renvoie 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 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
15
16
17
18

{
  "items": [
    {
      "rel_kind": "subaccount",
      "to_data_object": {
        "type_name": "account",
        "object_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 sous 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 de cet endpoint et la manière de les résoudre.