Breadcrumbs

Entidades Personalizadas

Uma "entidade personalizada" é um cadastro extra que o seu negócio criou na plataforma, além de Pessoa e Caso por exemplo, um cadastro de produtos, de pedidos, ou qualquer outra lista que o seu time tenha configurado. Esta página traz os três endpoints genéricos para criar, atualizar e buscar registros dentro desses cadastros personalizados. (Pessoa e Caso já têm seus próprios endpoints, documentados em Gestão de Pessoas e Gestão de Casos não precisam passar por aqui.)

Todas as requisições exigem o cabeçalho Authorization veja Autenticação e Segurança se ainda não souber como conseguir e usar o token.

Índice desta página

Criar Registro em Entidade

Permite criar novos registros em entidades personalizadas.

Request 

POST https://api.cvortex.com/v1/entity

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

entityLabel

string

Nome da entidade

Não entityLabel ou entityUUID deve ser informado

entityUUID

string

UUID da entidade

Não entityLabel ou entityUUID deve ser informado

fields

array

Array de campos da entidade

Não

fields[].fieldLabel

string

Nome do campo

Não fieldLabel ou fieldUUID deve ser informado

fields[].fieldUUID

string

UUID do campo

Não fieldLabel ou fieldUUID deve ser informado

fields[].value

string

Valor a ser atribuído ao campo

Sim

Response

Código

Descrição

200

Operação realizada com sucesso

Exemplo de request

JSON
{
  "entityLabel": "string",
  "entityUUID": "string",
  "fields": [
    { "fieldLabel": "string", "fieldUUID": "string", "value": "string" }
  ]
}

Atualizar Registro em Entidade

Permite atualizar registros existentes em entidades personalizadas.

Request 

PUT https://api.cvortex.com/v1/entity

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

entityLabel

string

Nome da entidade (entityLabel ou entityUUID deve ser informado)

Não

entityUUID

string

UUID da entidade (entityLabel ou entityUUID deve ser informado)

Não

fields

array

Array de campos da entidade

Não

fields[]._id

string

Id do objeto que será atualizado

Sim

fields[].version

int

Versão do documento do objeto

Sim

fields[].fieldLabel

string

Nome do campo (fieldLabel ou fieldUUID deve ser informado)

Não

fields[].fieldUUID

string

UUID do campo (fieldLabel ou fieldUUID deve ser informado)

Não

fields[].value

string

Valor a ser atribuído ao campo

Sim

Response

Código

Descrição

200

Operação realizada com sucesso

Exemplo de request

JSON
{
  "fields": [
    { "fieldUUID": "e5b563e341564e73858d1248fc51836b", "value": "Exemplo" },
    { "fieldUUID": "_id", "value": "11616e9e-2582-4324-a3a6-8c3814e8554e" },
    { "fieldUUID": "_version", "value": "1" }
  ],
  "entityUUID": "d48ebebce7ac487eacdc8157f6514299"
}

Buscar Registros em Entidade

Permite buscar registros em entidades usando filtros. Retorna no máximo 1000 registros filtrados e não possui paginação.

Request 

POST https://api.cvortex.com/v1/entity/by-filter

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

entityLabel

string

Nome da entidade. Pelo menos entityLabel ou entityUUID deve ser informado

Sim

entityUUID

string

UUID da entidade. Pelo menos entityLabel ou entityUUID deve ser informado

Não

entries

array

Campos da entidade a serem filtrados

Sim

entries[].fieldLabel

string

Nome do campo para busca. Pelo menos fieldLabel ou fieldUUID deve ser informado

Sim

entries[].fieldUUID

string

ID do campo para busca. Pelo menos fieldLabel ou fieldUUID deve ser informado

Não

entries[].operator

string

Operador de comparação: EQUAL, NOT_EQUAL, LESS_THAN, LESS_THAN_EQUAL, GREATER_THAN, GREATER_THAN_EQUAL, IS_NULL

Sim

entries[].value

string

Valor a ser comparado com o campo escolhido

Sim

Campos padrão presentes no response

Campo

Descrição

Updated by

Hash do último usuário que editou o registro

Deleted

Booleano

Created by

Hash do usuário que criou o registro

Updated at

Datetime

_version

Versão do documento (número)

Created at

Datetime

Além desses, o response traz todos os campos personalizados criados pelo usuário na entidade, com o tipo definido na plataforma.

Response

Código

Descrição

200

Operação realizada com sucesso

Exemplo de request

JSON
{
  "entityLabel": "Entidade",
  "entries": [
    { "fieldLabel": "_id", "operator": "EQUAL", "value": "93ed7cfe-feb7-489d-80d5-d2ab79bc39a9" }
  ]
}

Exemplo de response

JSON
[
  {
    "Updated by": "138a440e-c6c9-45c4-91fd-7d98d735704e",
    "Deleted": false,
    "Created by": "727cb771-9df0-478b-838e-68e2597939af",
    "_id": "93ed7cfe-feb7-489d-80d5-d2ab79bc39a9",
    "Updated at": 1747685418482,
    "_version": "3",
    "Link": "Texto do Campo",
    "Created at": 1747684331880
  }
]