Breadcrumbs

Formulários de Casos

Endpoints para consultar formulários de criação de caso e para criar casos a partir deles.

Todas as requisições exigem o cabeçalho Authorization veja Autenticação e Segurança.

Índice desta página

Buscar formulário de caso por ID

Permite buscar o formulário de criação de caso pelo seu ID único.

Request 

GET https://api.cvortex.com/v1/case-forms/{id}

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID do formulário de caso

Sim

Response

json

JSON
{
  "name": "string",
  "description": "string",
  "businessUnitId": "string",
  "assignCaseToAgent": "boolean",
  "createIDPrefixForManualCase": "boolean",
  "identifierPrefix": "string",
  "fields": [
    {
      "caseFormId": "string",
      "entityUUID": "string",
      "fieldUUID": "string",
      "label": "string",
      "removed": "boolean",
      "required": "boolean",
      "order": "integer (int64)",
      "fieldType": "string",
      "defaultValue": "string",
      "blocked": "boolean",
      "hidden": "boolean"
    }
  ]
}

Criar caso por formulário (v1)

Permite criar um caso a partir do formulário.

Request 

POST https://api.cvortex.com/v1/case/forms/{id}

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID do formulário de caso

Sim

Observações importantes

  • Os campos personRequesterFullName, personRequesterEmail e personRequesterDocument da requisição devem ser enviados quando o campo personRequesterId não estiver presente na lista de dynamicFields ou seja, se o cliente ainda não estiver identificado no momento da criação do caso, utilize personRequesterFullName e uma nova pessoa será criada junto ao caso. Se o cliente já for conhecido, utilize o _id da própria pessoa dentro do campo personRequesterId.

  • O campo priority, que deve ser enviado na lista de dynamicFields caso não haja um valor padrão configurado no cadastro de formulário de casos, tem três valores possíveis: LOW, MEDIUM e HIGH.

  • Para a correta criação do caso, os campos configurados no formulário não podem estar marcados com o parâmetro "Ocultar campo no formulário".

Body

JSON
{
  "personRequesterFullName": "string",
  "personRequesterEmail": "string",
  "personRequesterDocument": "string",
  "dynamicFields": [
    {
      "entityUUID": "string",
      "fieldUUID": "string",
      "value": "string"
    }
  ]
}

Response

JSON
{
  "id": "string",
  "caseId": "string"
}

Exemplo criando uma nova pessoa a cada requisição

JSON
{
   "personRequesterFullName": "nome do cliente",
   "personRequesterDocument": "documento do cliente",
   "personRequesterEmail": "email do cliente",
   "dynamicFields": [
      { "entityUUID": "case", "fieldUUID": "subject", "value": "comentário desejado" },
      { "entityUUID": "case", "fieldUUID": "caseType", "value": "_id do registro CaseType" },
      { "entityUUID": "case", "fieldUUID": "caseStatus", "value": "_id do registro CaseStatus" },
      { "entityUUID": "case", "fieldUUID": "priority", "value": "LOW ou MEDIUM ou HIGH" },
      { "entityUUID": "_id de Case Detail", "fieldUUID": "_id do Atributo de Case Detail", "value": "Valor desejado para o campo" }
   ]
}

Exemplo com uma pessoa já existente

JSON
{
   "dynamicFields": [
      { "entityUUID": "case", "fieldUUID": "subject", "value": "comentário desejado" },
      { "entityUUID": "case", "fieldUUID": "caseType", "value": "_id do registro CaseType" },
      { "entityUUID": "case", "fieldUUID": "caseStatus", "value": "_id do registro CaseStatus" },
      { "entityUUID": "case", "fieldUUID": "priority", "value": "LOW ou MEDIUM ou HIGH" },
      { "entityUUID": "case", "fieldUUID": "personRequesterId", "value": "_id do registro Person" },
      { "entityUUID": "_id de Case Detail", "fieldUUID": "_id do Atributo de Case Detail", "value": "Valor desejado para o campo" }
   ]
}

Criar caso por formulário (v2)

Cria um novo caso com base em um formulário pré-configurado, permitindo a criação ou associação de uma pessoa e o preenchimento de campos dinâmicos (do caso e dos detalhes do caso).

Request 

POST https://api.cvortex.com/v2/case/forms/{formId}

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

personRequest

object

Dados da pessoa associada ao caso

Sim

personRequest.fullName

string

Nome completo da pessoa

Sim

personRequest.document

string

Documento da pessoa (ex: CPF)

Sim

personRequest.email

string

Email principal

Não

personRequest.contacts

array

Lista de contatos (telefone, e-mail, etc.)

Não

caseAndDetailFields

array

Lista de campos a serem preenchidos no caso (entidade case)

Sim

caseAndDetailFields[].entityUUID

string

Deve ser "case"

Sim

caseAndDetailFields[].fields

array

Lista de campos contendo fieldUUID e value

Sim

Estrutura dos campos (caseAndDetailFields[].fields)

Nome

Tipo

Descrição

Obrigatório

fieldUUID

string

UUID do campo a ser preenchido

Sim

value

string

Valor atribuído ao campo

Sim

entityUUID

string

Identificador da entidade (ex: case)

Sim

Exemplo de Payload

JSON
{
  "personRequest": {
    "contacts": [
      { "channelType": "VOICE", "contactType": "MOBILE_PHONE", "value": "34999999999" },
      { "channelType": "VOICE", "contactType": "LANDLINE_PHONE", "value": "3499999999" },
      { "channelType": "EMAIL", "contactType": "EMAIL", "value": "email@empresas.com" }
    ],
    "document": "012.345.678-89",
    "email": "email@empresas.com",
    "fullName": "Nome Sobrenome"
  },
  "caseAndDetailFields": [
    {
      "entityUUID": "case",
      "fields": [
        { "entityUUID": "case", "fieldUUID": "subject", "value": "Caso manual criado via API" },
        { "entityUUID": "case", "fieldUUID": "caseType", "value": "d2af060c-7251-41cd-aee3-9fda35d14c7c" },
        { "entityUUID": "case", "fieldUUID": "caseStatus", "value": "c3003f97-f701-40fa-9792-8fc4dbec42c6" },
        { "entityUUID": "case", "fieldUUID": "priority", "value": "LOW" }
      ]
    }
  ]
}

Response

Código

Descrição

200

Operação realizada com sucesso
JSON
{
  "caseId": 10880
}