Listar tipos de objetos de datos

Usa este endpoint para listar los tipos de objetos de datos en un espacio de trabajo.

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 utilizar 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 consulta

La siguiente tabla enumera y describe los parámetros de consulta para el endpoint /data_objects/types.

Ejemplo de solicitud

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

Carga útil de solicitud de ejemplo

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

1
2
3
4
5

{
  "search_term": "acc",
  "limit": 2,
  "offset": 0
}

Solicitud cURL de ejemplo

Este ejemplo lista los tipos de objetos de datos que coinciden con el término de búsqueda acc, devolviendo dos resultados por página.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types?search_term=acc&limit=2&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Respuesta

Esta sección incluye una respuesta exitosa de ejemplo y los campos de la 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
17

{
  "items": [
    {
      "type_name": "account",
      "metadata": { "display_name_source": "name" }
    },
    {
      "type_name": "contact",
      "metadata": {}
    }
  ],
  "total_count": 2,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

metadata.display_name_source está presente cuando se ha configurado un campo de nombre de visualización para el tipo.

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.