Objektbeziehung erstellen

Verwenden Sie diesen Endpunkt, um eine einzelne gerichtete Beziehungskante zwischen zwei Datenobjekten zu erstellen.

Wichtig

Data Objects ist allgemein verfügbar, Ihr Workspace muss jedoch für Accounts bereitgestellt sein, bevor Sie diesen Endpunkt verwenden können. Um die Bereitstellung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.object_relationships.create.

Rate-Limit

Dieser Endpunkt gehört zum Data-Objects-Schreib-Bucket mit einem Standardlimit von 1000 Anfragen pro Minute.

Pfadparameter

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

Anfrageparameter

Die folgende Tabelle listet und beschreibt die JSON-Parameter im Anfragekörper für den Endpunkt /data_objects/objects/{type_name}/{object_id}/object_relationships.

Beispielanfrage

Dieser Abschnitt enthält eine Beispiel-JSON-Payload und eine cURL-Beispielanfrage.

Beispiel-Anfrage-Payload

1
2
3
4
5
6

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}

cURL-Beispielanfrage

Dieses Beispiel verknüpft acct-123 mit acct-456 als subaccount, wobei acct-123 die Quelle der Beziehung ist.

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}'

Antwort

Dieser Abschnitt enthält eine erfolgreiche Beispielantwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 201 könnte den folgenden Antwortkörper zurückgeben.

1
2
3
4
5
6
7
8
9
10
11

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "object_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder einer erfolgreichen Antwort.

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt auf und zeigt, wie Sie diese beheben können.