Document

Document é a principal entidade do Workflow. Ela é responsável por armazenar todas as informações associadas a atividade que será executada.

Todos os métodos precisam de autenticação

create

POST /document/create

Essa API é utilizada para criação de documentos. Todas as informações enviadas serão salvas e podem ser resgatadas utilizando as API's de busca.

Headers

Name	Type	Description
Authorization	string	Bearer <token>

Request Body

Name	Type	Description
status_id	number	Número de ID do status
product_id	number	Número de ID do produto
modality_identifier	string	Texto nome da modalidade
cpf	string	Texto identificador (CPF/CNPJ/susep)
name	string	Nome do cliente (envio de comunicações)
phone	string	Telefone do cliente (envio de comunicações)
email	string	E-mail do cliente (envio de comunicações)
sla_total	number	SLA total do documento em horas
source	string	Fonte de envio do documento (por exemplo: chatbot/postman/robô)
filled_columns	object	Objeto JSON com informações extras sobre o documento (caso atualizado, as informações serão concatenadas)

201 Este retorno traz informações sobre a criação do documento para verificação. Os atributos são os mesmos da requisição, com a adição das seguintes informações: uuid: uuid gerado para o documento criado sla_start: data de início do SLA sla_end: data de término do SLA sla_end_status: data de término do SLA para o status atual date_time: data da última atualização de status created_at: data de criação do documento updated_at: data da última atualização geral id: ID do documento criado protocol: protocolo gerado para o documento criado

{
    "status_id": <status_id> : number,
    "product_id": <product_id> : number,
    "modality_identifier": <modality_identifier> : string,
    "cpf": <campo_identificador> : string,
    "email": <email> : string,
    "phone": <phone> : string,
    "name": <name> : string,
    "sla_total": <sla_total> : number,
    "source": <source> : string,
    "filled_columns": <filled_columns> : jsonObject,
    "modality_id": <modality_id> : number,
    "uuid": <uuid> : string,
    "sla_start": "<sla_start> : Date",
    "sla_end": "<sla_end> : Date",
    "sla_end_status": <sla_end_status> : Date,
    "date_time": <date_time> : Date,
    "created_at": <created_at> : Date,
    "updated_at": <updated_at> : Date,
    "id": <id> : number,
    "protocol": <protocol> : string,
}

404 Os ID complementares enviados não existem no banco de dados

{
    "error": "NotFound: Provided (campo externo relacionado) parameter not exists on database"
}

422 Cadastro inválido, lança exceção no banco. Descrição do erro será melhor descrita.

{
    "error": "Database error: Throw node exception"
}

Body exemplo

{
    "status_id": <status_id>,
    "product_id": <product_id>,
    "modality_identifier": <modality_identifier>,
    "cpf": <campo_identificador>,
    "email": <email>,
    "phone": <phone>,
    "name": <name>,
    "sla_total": <sla_total>,
    "source": <source>,
    "filled_columns": <filled_columns>,
}

updateById

POST /document/updateById

API utilizada para editar um documento existente

Request Body

Name	Type	Description
id	number	ID do documento que vai ser atualizado
status_id	number	número de ID do status
product_id	number	número de ID do produto
modality_identifier	string	texto nome da modalidade
cpf	string	texto identificador(CPF/CNPJ/susep)
email	string	e-mail do cliente (envio de comunicações)
phone	string	telefone do cliente(envio de comunicações)
name	string	nome do cliente (envio de comunicações)
sla_total	number	SLA total do documento (horas)
source	string	fonte de envio do documento (chatbot/postman/robô)
filled_columns	object	objeto JSON com informações extras sobre o documento (caso atualizado, as informações serão concatenadas)

200 Documento atualizado com sucesso. Atributos: id: ID do documento que foi atualizado, uuid: uuid correspondente ao documento que foi atualizado, status_id: número de ID do status do documento que foi atualizado, product_id: número de ID do produto do documento que foi atualizado, user_id: número de ID do usuário associado ao documento que foi atualizado, source: fonte de envio do documento que foi atualizado, protocol: protocolo correspondente ao documento que foi atualizado, cpf: texto identificador do documento que foi atualizado, email: e-mail do documento que foi atualizado, phone: phone do documento que foi atualizado, name: name do documento que foi atualizado, sla_total: sla total do documento que foi atualizado, sla_start: data de início de SLA do documento que foi atualizado, sla_end: data de fim de SLA do documento que foi atualizado, sla_end_status: data de término do SLA para status atual do documento que foi atualizado, modality_identifier: texto nome da modalidade, filled_columns: objeto JSON com informações extras sobre o documento (caso atualizado, as informações serão concatenadas), date_time: data da última atualização de status do documento atualizado, created_at: data de criação do documento atualizado, updated_at: data da última atualização geral do documento atualizado, modality_id: modality_id correspondente ao modality_identifier do documento atualizado, date_finished: data da primeira atualização para um status categoria final do documento atualizado

{
    "id": <id>
    "uuid": <uuid>
    "status_id": <status_id>
    "product_id": <product_id>
    "user_id": <user_id>
    "source": <source>
    "protocol": <protocol>
    "cpf": <campo_identificador>
    "email": <email>
    "phone": <phone>
    "name": <name>
    "sla_total": <sla_total>
    "sla_start": <sla_start>
    "sla_end": <sla_end>
    "sla_end_status": <sla_end_status>
    "modality_identifier": <modality_identifier>
    "filled_columns": <filled_columns>
    "date_time": <date_time>
    "created_at": <created_at>
    "updated_at": <updated_at>
    "modality_id": <modality_id>
    "date_finished": <date_finished>
}

404 IDs complementares enviados não existem no banco de dados.

{
    "error": "NotFound: Provided (campo externo relacionado) parameter not exists on database"
}

422 Consistência inválida, lança exceção no banco.

{
    "error": "Database error: Throw node exception"
}

Body exemplo

{
    "id": <id>,
    "status_id": <status_id>,
    "product_id": <product_id>,
    "modality_identifier": <modality_identifier>,
    "cpf": <campo_identificador>,
    "email": <email>,
    "phone": <phone>,
    "name": <name>,
    "sla_total": <sla_total>,
    "source": <source>,
    "filled_columns": <filled_columns>
}

loadById

POST /document/loadById

API utilizada para consultar um documento existente pelo ID.

Request Body

Name	Type	Description
id	number	id do documento que vai ser consultado

200 Retorno do documento consultado. Atributos: id: ID do documento consultado status_id: número de ID do status do documento consultado uuid: uuid correspondente ao documento consultado product_id: número de ID do produto do documento consultado protocol: protocolo correspondente ao documento consultado filled_columns: objeto JSON com informações extras sobre o documento consultado date_time: data da última atualização de status do documento consultado sla_end_status: data de término do SLA para status atual do documento consultado updated_at: data da última atualização geral do documento consultado fields_to_show: CPF: campo CPF formatado Email: campo e-mail formatado Telefone: campo phone Cliente: campo name Fonte: campo source Modalidade: campo modality_identifier Criado em: campo created_at formatado product: detalhamento sobre produto relacionado status: detalhamento sobre status relacionado observation: detalhamento sobre observation relacionadas attachment: detalhamento sobre attachments relacionados step: detalhamento sobre step atual

{
    "id": <id>,
    "status_id": <status_id>,
    "uuid": <uuid>,
    "product_id": <product_id>,
    "protocol": <protocol>,
    "filled_columns": <filled_columns>,
    "date_time": <date_time>,
    "sla_end_status": <sla_end_status>,
    "updated_at": <updated_at>,
    "fields_to_show": {
        "CPF": <campo_identificador>,
        "Email": <email>,
        "Telefone": <phone>,
        "Cliente": <name>,
        "Fonte": <source>,
        "Modalidade": <modality_identifier>,
        "Criado em": <created_at>,
    },
    "product": <product>,
    "status": <status>,
    "observation": <observation>,
    "attachment": <attachment>,
    "step": <step>
}

400 Campo enviado é inválido.

{
    "error": "BadRequest: Invalid parameters provided: id"
}

404 ID consultado não existe no banco de dados.

{
    "error": "NotFound: Provided id parameter not exists on database"
}

Body Exemplo

{
    "id": <id>
}

loadByCPF

POST /document/loadByCPF

API utilizada para consultar documentos existentes com o campo CPF idêntico ao valor enviado.

Request Body

Name	Type	Description
cpf	string	texto de identificar que será consultado
categories	string	categorias dos status para os documentos consultados

200 Lista de documentos para o CPF consultado. Atributos: id: id do documento consultado status_id: número de ID do status do documento consultado uuid: uuid correspondente ao documento consultado product_id: número de ID do produto do documento consultado protocol: protocolo correspondente ao documento consultado filled_columns: objeto JSON com informações extras sobre o documento consultado date_time: data da última atualização de status do documento consultado sla_end_status: data de término do SLA para status atual do documento consultado updated_at: data da última atualização geral do documento consultado fields_to_show: CPF: campo CPF formatado Email: campo e-mail formatado Telefone: campo phone Cliente: campo name Fonte: campo source Modalidade: campo modality_identifier Criado em: campo created_at formatado product: detalhamento sobre produto relacionado status: detalhamento sobre status relacionado observation: detalhamento sobre observation relacionadas

[
  {
      "id": <id>,
      "status_id": <status_id>,
      "uuid": <uuid>,
      "product_id": <product_id>,
      "protocol": <protocol>,
      "filled_columns": <filled_columns>,
      "date_time": <date_time>,
      "sla_end_status": <sla_end_status>,
      "updated_at": <updated_at>,
      "fields_to_show": {
          "CPF": <CPF>,
          "Email": <Email>,
          "Telefone": <Telefone>,
          "Cliente": <Client>,
          "Fonte": <Fonte>,
          "Modalidade": <Modalidade>,
          "Criado em": <Criado em>
      },
      "product":<product> : Object<Product>,
      "status":<status> Object<Status>,
      "observation":<observation> Observation[],
      "attachment":<attachment> Attachment[],
      "step":<step> : Object<Step>
  }
]

400 Campo enviado é inválido.

{
    "error": "BadRequest: Invalid parameters provided: cpf"
}

Body Exemplo

{
    "cpf": <campo_identificador>,
    "categories": <categories>
}