Obter tipo de objeto de dados

Use este endpoint para retornar um tipo de objeto de dados e sua definição de esquema.

Importante

Objetos de dados está atualmente em acesso antecipado. Seu espaço de trabalho precisa estar ativado antes que as permissões de chave de API de objetos de dados apareçam em Configurações > Chaves de API.

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 50 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /data_objects/types/{type_name}.

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 nesta solicitação.

1
2
3

{
  "type_name": "account"
}

Exemplo de solicitação cURL

Este exemplo recupera a definição do tipo de objeto de dados account.

1
2

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.

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 descreve os campos permitidos do objeto. As operações de escrita ainda rejeitam campos não declarados, mesmo que o esquema desta resposta seja descritivo.

Parâmetros da resposta

A tabela a seguir lista e descreve os campos de uma resposta bem-sucedida.

Erros

A tabela a seguir lista os erros comuns para este endpoint e como resolvê-los.