Listar relacionamentos de objetos

Use este endpoint para listar objetos de dados relacionados a partir de uma âncora de objeto.

Importante

O Data Objects está em disponibilidade geral, mas seu espaço de trabalho precisa estar provisionado para Contas antes de você usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Contas e preencha o questionário. Para mais detalhes, consulte Ativar Contas.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão data_objects.read.

Limite de frequência

Este endpoint está no bucket de leitura de Data Objects, com um limite padrão de 1.000 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Parâmetros de consulta

A tabela a seguir lista e descreve os parâmetros de consulta para o endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil de parâmetros e um exemplo de solicitação cURL.

Exemplo de carga útil da solicitação

Use este objeto JSON como referência para os parâmetros da solicitação.

1
2
3
4
5
6
7
8

{
  "type_name": "account",
  "object_id": "acct-123",
  "anchor": "source",
  "rel_kind": "subaccount",
  "limit": 100,
  "offset": 0
}

Exemplo de solicitação cURL

Este exemplo lista os registros de subaccount aos quais acct-123 se vincula, retornando a primeira página de resultados.

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'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta.

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
}

Com anchor=target, os objetos relacionados são retornados como from_data_object.

Parâmetros da resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Erros

A tabela a seguir lista os erros comuns deste endpoint e como resolvê-los.