GET
/
v1
/
data-entities
/
{entity_name}
/
documents
/
{key}

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

key
string
required

Chave/Nome do documento

Query Parameters

fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

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
id
string

Identificador exclusivo para o objeto.

key
string

Chave/Nome que será dado ao documento

value
object

Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

dataEntity
string

Id da entidade, ao qual o documento está relacionado

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.

createdBy
object
updatedBy
object
Obter documentosCriar documento