Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Obtener objeto de datos

get

/data_objects/objects/{type_name}/{object_id}

Usa este endpoint para devolver un objeto de datos.

Importante

Los objetos de datos están disponibles de forma general, pero tu espacio de trabajo debe estar aprovisionado para Cuentas antes de que puedas usar este endpoint. Para solicitar el aprovisionamiento, ve a Configuración de datos > Cuentas y completa el cuestionario. Para más detalles, consulta Habilitar Cuentas.

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 1000 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}/{object_id}.

Parámetro	Obligatorio	Tipo de datos	Descripción
`type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos
`object_id`	Obligatorio	Cadena	Identificador del objeto

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 de esta solicitud.

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

Ejemplo de solicitud cURL

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

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.

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

Parámetros de respuesta

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

Parámetro	Obligatorio	Tipo de datos	Descripción
`data_object`	Obligatorio	Objeto	Registro del objeto de datos devuelto
`data_object.type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos
`data_object.object_id`	Obligatorio	Cadena	Identificador del objeto de datos
`data_object.attributes`	Obligatorio	Objeto	Atributos del objeto indexados por nombre de campo

Errores

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

Estado	Causa	Orientación
`404`	Tipo no encontrado (`data-object-type-not-found`) u objeto no encontrado (`data-object-not-found`)	Confirma que tanto `type_name` como `object_id` existen en el espacio de trabajo.
`401`	Clave de API REST faltante o no válida	Verifica que el encabezado `Authorization` use `Bearer YOUR_REST_API_KEY` y que la clave esté activa.
`403`	La clave de API no tiene permiso o la solicitud está bloqueada por la lista de permitidos	Confirma que la clave tiene el permiso `data_objects.read` y que tu IP de origen está en la lista de permitidos de la clave, si está configurada.
`429`	Límite de velocidad excedido	Vuelve a intentarlo después de `X-RateLimit-Reset` y reduce la frecuencia de las solicitudes.

New Stuff!