GET
/
v1
/
data-entities
/
{entity_name}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_name
string
required

Nome da entidade

Query Parameters

fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

Response

200 - application/json

Este objeto representa uma entidade.

id
string

Identificador exclusivo para o objeto.

name
string

Nome da entidade a ser criada

locked
boolean

Locked true significa que é do sistema e não pode ser alterado ou removido.

schema
object

JSON Schema da entidade. Os tipos permitidos são: string, number, boolean, array, object.

createdAt
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.