Listar tipos de relación de objetos

Usa este endpoint para listar los tipos de relaciones disponibles para vínculos de objeto a objeto en una dirección de anclaje determinada.

Importante

Los objetos de datos se encuentran actualmente en acceso anticipado. Tu espacio de trabajo debe estar habilitado antes de que los permisos de clave de API de objetos de datos aparezcan en Configuración > Claves de API.

Requisitos previos

Para usar este endpoint, necesitas una clave de API con el permiso data_objects.read.

Límite de velocidad

Este endpoint se encuentra en el contenedor de lectura de objetos de datos con un límite predeterminado de 50 solicitudes por minuto.

Parámetros de ruta

La siguiente tabla enumera y describe los parámetros de ruta del endpoint /data_objects/types/{type_name}/object_relationship_types.

Parámetros de consulta

La siguiente tabla enumera y describe los parámetros de consulta del endpoint /data_objects/types/{type_name}/object_relationship_types.

Ejemplo de solicitud

Esta sección incluye un ejemplo de carga útil de parámetros y un ejemplo de solicitud cURL.

Ejemplo de carga útil de solicitud

Usa este objeto JSON como referencia para los parámetros de solicitud.

1
2
3
4
5
6

{
  "type_name": "account",
  "anchor": "source",
  "limit": 10,
  "offset": 0
}

Ejemplo de solicitud cURL

Este ejemplo lista los tipos de relación de objetos disponibles para el tipo account cuando account es el origen de la relación.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account/object_relationship_types?anchor=source&limit=10&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Respuesta

Esta sección incluye un ejemplo de respuesta exitosa y los campos de respuesta.

Ejemplo de respuesta exitosa

El código de estado 200 podría devolver el siguiente cuerpo de respuesta.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "items": [
    {
      "from_type_name": "account",
      "to_type_name": "account",
      "rel_kind": "subaccount",
      "display_name": "subaccount",
      "related_type_name": "account"
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 10
}

related_type_name es el tipo en el otro lado de la relación para el anchor seleccionado.

Parámetros de respuesta

La siguiente tabla enumera y describe los campos en una respuesta exitosa.

Errores

La siguiente tabla enumera los errores comunes de este endpoint y cómo resolverlos.