Obter tipo de objeto de dados
/data_objects/types/{type_name}
Use este endpoint para retornar um tipo de objeto de dados e sua definição de esquema.

O recurso Objetos de dados está disponível para todos, mas seu espaço de trabalho precisa estar provisionado para Contas antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Contas e preencha o questionário. Para saber mais, consulte Ativar contas.
Pré-requisitos
Para usar este endpoint, você precisa de uma chave de API com a permissão data_objects.read.
Limite de frequência
Este endpoint está no bucket de leitura de Objetos de dados, com um limite padrão de 1.000 solicitações por minuto.
Parâmetros de caminho
A tabela a seguir lista e descreve os parâmetros de caminho do endpoint /data_objects/types/{type_name}.
| Parâmetro | Obrigatório | Tipo de dados | Descrição |
|---|---|---|---|
type_name |
Obrigatório | String | Nome de máquina do tipo de objeto de dados |
Exemplo de solicitação
Esta seção inclui um exemplo de carga útil de parâmetro de caminho e um exemplo de solicitação cURL.
Exemplo de carga útil da solicitação
Use este objeto JSON como referência para o parâmetro de caminho desta solicitação.
{
"type_name": "account"
}
Exemplo de solicitação cURL
Este exemplo recupera a definição do tipo de objeto de dados account.
curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
Resposta
Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.
Exemplo de resposta bem-sucedida
O código de status 200 pode retornar o seguinte corpo de resposta.
{
"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 descreve os campos permitidos do objeto. As operações de escrita continuam rejeitando campos não declarados, mesmo que o esquema desta resposta seja apenas descritivo.
Parâmetros da resposta
A tabela a seguir lista e descreve os campos de uma resposta bem-sucedida.
| Parâmetro | Obrigatório | Tipo de dados | Descrição |
|---|---|---|---|
data_object_type |
Obrigatório | Objeto | Registro do tipo de objeto de dados retornado |
data_object_type.type_name |
Obrigatório | String | Nome de máquina do tipo de objeto de dados |
data_object_type.metadata |
Obrigatório | Objeto | Objeto de metadados do tipo |
data_object_type.schema_def |
Obrigatório | Objeto | Definição de esquema JSON para os atributos do objeto |
Erros
A tabela a seguir lista os erros comuns deste endpoint e como resolvê-los.
| Status | Causa | Orientação |
|---|---|---|
404 |
Tipo não encontrado (data-object-type-not-found) |
Confirme se type_name existe no espaço de trabalho e corresponde exatamente ao nome de máquina. |
401 |
Chave da API REST ausente ou inválida | Verifique se o cabeçalho Authorization usa Bearer YOUR_REST_API_KEY e se a chave está ativa. |
403 |
A chave de API não tem permissão ou a solicitação está bloqueada pela lista de permissões | Confirme se a chave tem a permissão data_objects.read e se o seu IP de origem está na lista de permissões da chave, caso configurada. |
429 |
Limite de frequência excedido | Tente novamente após X-RateLimit-Reset e reduza a frequência das solicitações. |