Fluxos e Workflows

Buscar Ações por status e tipo do caso

Permite buscar ações, utilizando o status e tipo do caso como parâmetros de busca.

Request

CODE

GET https://api.cvortex.com/v1/workflow-executions/actions/{statusId}/{caseTypeId}

Header

CODE

Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`StatusId`	ID da `statusFunction`, correspondente a propriedade no flow `status_status_property`	Sim
`CaseTypeId`	ID do tipo do caso, correspondente a propriedade no flow `imperative_start_case_type_property`	Sim

Response

CODE

[
{
   "workflowId": “string”
   "actions": ["string"]
}
]

Executar uma ação de um fluxo de atendimento

Permite executar uma ação de um fluxo de atendimento a partir de um caso e é necessário informar os parâmetros: Id da ação, Id do caso, Id do tipo do caso, Id da função status e lista de requisições do formulário.

Request

CODE

POST https://api.cvortex.com/v1/workflow-executions

Header

CODE

Authorization

Observação:
Com “F12” no navegador pela tela de cadastro do formulário de ação, é possível copiar os valores que precisam ser enviados dentro do “formRequestList”.

Body

JSON

{
   "actionId": “ID Hash da ação a ser executada”,
   "caseId": “ID Hash do caso”,
   "caseTypeId": “ID Hash do tipo de caso do caso em questão”,
   "statusFunctionId": “ID Hash do status de caso no fluxo”,
   "formRequestList":[
      {
         "binding": “string”,
         "value": “string”
      }
   ]
}

Response

JSON

{
   "workflowExecutionsRequest": “ID Hash da requisição WF criada”
}

Observação:

A ação deve estar vinculada ao status do caso dentro do fluxo de atendimento no workflow studio
A ação somente será executada se o caso estiver no status informado

Buscar respostas de questionários por Caso e Ação

Recupera a lista de respostas de questionários de um determinado caso e ação.

Request

CODE

GET https://api.cvortex.com/v1/questionnaire/questionnaire-answer

Header

CODE

Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`case-id`	ID Hash correspondente ao caso	Sim
`action-id`	ID correspondente a ação do caso	Sim

Response

JSON

[
   {
      "id":"a9378ad3-8730-4800-852f-e96691508103",
      "name":"Teste Cosmos",
      "createdAt":1706301660041,
      "questions":[
         {
            "id":"40a7e004-f9ea-4f90-8445-d0f89987dd15",
            "label":"Questão 1",
            "type":"DATE",
            "required":false,
            "answer":"1706301600000",
            "options":[
            ],
            "answered":true
         },
         {
            "id":"b1f953cf-752b-4d5f-9d5d-8787bfb3c3c1",
            "label":"Questão 1",
            "type":"TEXT",
            "required":false,
            "answer":"abc",
            "options":[
            ],
            "answered":true
         }
      ]
   }
]