Objektbeziehung ersetzen

Verwenden Sie diesen Endpunkt, um eine Objektbeziehung zu erstellen oder zu ersetzen.

Wichtig

Data Objects befindet sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die Data-Objects-API-Schlüssel-Berechtigungen unter Einstellungen > API-Schlüssel angezeigt werden.

Voraussetzungen

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

Rate-Limit

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

Pfadparameter

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

Anfrageparameter

Die folgende Tabelle listet und beschreibt die JSON-Anfrageparameter für den Endpunkt /data_objects/objects/{type_name}/{external_id}/object_relationships.

Beispielanfrage

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

Beispiel-Anfrage-Payload

1
2
3
4
5
6
7

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_external_id": "acct-456",
  "anchor": "source",
  "attributes": {}
}

Beispiel-cURL-Anfrage

Dieses Beispiel ersetzt die subaccount-Beziehung zwischen acct-123 und acct-456 und überschreibt dabei alle zuvor gespeicherten Attribute.

1
2
3
4
5
6
7
8
9
10

curl --location --request PUT '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_external_id": "acct-456",
  "anchor": "source",
  "attributes": {}
}'

Antwort

Dieser Abschnitt enthält eine Beispielantwort bei Erfolg sowie die Antwortfelder.

Beispiel einer erfolgreichen Antwort

Der Statuscode 200 kann die folgende Antwort zurückgeben.

1
2
3
4
5
6
7
8
9
10
11

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "external_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 und deren Behebung auf.