Criar documento

POST 
/v1/data-entities/:entity_name/documents

Anexa um documento à entidade.

Request

Path Parameters

entity_name stringrequired
Nome da entidade
Example: motivos_de_cancelamento

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.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

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.
Example: data.loan

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

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

application/json

Body

keystringrequired
Chave/Nome que será dado ao documento
Example: funcionario_desligado
valueobjectrequired
Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido
Example: {}

Responses

200

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

application/json

Schema

Schema

idstring
Identificador exclusivo para o objeto.
Example: doc_5f92f01728e009f403d8502e
keystring
Chave/Nome que será dado ao documento
Example: funcionario_desligado
valueobject
Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido
Example: {}
dataEntitystring

Id da entidade, ao qual o documento está relacionado

createdAtdate-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAtdate-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deletedboolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "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"
  }
}