POST
/
v1
/
data-entities
/
{entity_name}
/
documents
curl --request POST \
  --url https://api.base39.io/v1/data-entities/{entity_name}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "funcionario_desligado",
  "value": {}
}'
{
  "id": "doc_5f92f01728e009f403d8502e",
  "key": "funcionario_desligado",
  "value": {},
  "dataEntity": "<string>",
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Path Parameters

​
entity_name
string
required

Nome da entidade

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.

Body

application/json

Criar um documento.

​
key
string
required

Chave/Nome que será dado ao documento

Example:

"funcionario_desligado"

​
value
object
required

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

Example:
{}

Response

200 - application/json
Retorna o objeto `Document` se a criação for bem-sucedida; retorna erro se os parâmetros forem inválidos.

Este objeto representa um documento.

​
id
string

Identificador exclusivo para o objeto.

Example:

"doc_5f92f01728e009f403d8502e"

​
key
string

Chave/Nome que será dado ao documento

Example:

"funcionario_desligado"

​
value
object

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

Example:
{}
​
dataEntity
string

Id da entidade, ao qual o documento está relacionado

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

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

Example:

false

​
createdBy
object
​
updatedBy
object
Obter um documentoAtualizar documento