Obtener tipo de objeto de datos

Utiliza este endpoint para devolver un tipo de objeto de datos y su definición de esquema.

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 ruta

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

Solicitud de ejemplo

Esta sección incluye una carga útil de muestra para parámetros de ruta y una solicitud cURL de ejemplo.

Carga útil de solicitud de ejemplo

Utiliza este objeto JSON como referencia para el parámetro de ruta en esta solicitud.

1
2
3

{
  "type_name": "account"
}

Solicitud cURL de ejemplo

Este ejemplo recupera la definición del tipo de objeto de datos account.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account' \
--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

{
  "data_object_type": {
    "type_name": "account",
    "metadata": { "display_name_source": "name" },
    "schema_def": {
      "type": "object",
      "properties": {
        "name": { "type": "string", "title": "Name" },
        "industry": { "type": "string", "title": "Industry" },
        "renewal_date": { "type": "string", "format": "date-time", "title": "Renewal date" }
      },
      "required": ["name"]
    }
  }
}

schema_def describe los campos de objeto permitidos. Las escrituras seguirán rechazando campos no declarados aunque el esquema de esta respuesta sea descriptivo.

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.