Obtener objeto de datos

Usa este endpoint para devolver un objeto de datos.

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/objects/{type_name}/{external_id}.

Ejemplo de solicitud

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

Ejemplo de carga útil de solicitud

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

1
2
3
4

{
  "type_name": "account",
  "external_id": "acct-123"
}

Ejemplo de solicitud cURL

Este ejemplo recupera el registro de cuenta acct-123 y sus atributos almacenados.

1
2

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

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

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.