Tarefa
O objeto Tarefa representa uma única tarefa realizada ou em andamento por um usuário. Por exemplo, ligar para um lead ou se deslocar até um local em campo podem ser modelados como tarefas.
Basicamente, uma tarefa é definida pelos seguintes campos
status
Cada tarefa pode ter um dos seguintes status
- OPEN
- COMPLETED
- CANCELLED Quando uma tarefa está em andamento, seu status é
OPEN. Uma tarefa pode ser criada no estadoCOMPLETED— é a isso que nos referimos como registrar uma tarefa.
data
data é um campo JSON que contém os dados reais que definem uma instância de tarefa. A chave é o shortId ou o id do atributo da tarefa. Todas as APIs internas publicam os dados como pares id:value, enquanto as APIs externas publicam os dados como pares shortId:value
Exemplo:
{ "primary_disposition": "CALLBACK", "when_to_callback": 1634025183219, "first_name": "Cixin", "last_name": "Liu", "remarks": "lead wants a callback"}campos
nome | tipo de dado | informações do tipo | descrição |
|---|---|---|---|
id | string | uuid | id da tarefa — gerado automaticamente |
title | string |
| título da tarefa |
description | string |
| descrição da tarefa |
order | number |
| posição da tarefa |
status | string |
| pode ser OPEN, COMPLETED ou CANCELLED |
team | string | uuid | id da equipe à qual esta tarefa pertence |
stateTask | string | uuid | id da stateTask que define o esquema desta tarefa |
taskType | string |
| tipo de tarefa |
createdBy | string | uuid | id do usuário que criou a tarefa |
assignedTo | string | uuid | id do usuário a quem esta tarefa está atribuída |
belongsTo | string | uuid | id do pod ao qual esta tarefa pertence |
startsAt | number | epoch ms | data e hora em que a tarefa começou |
endsAt | number | epoch ms | data e hora em que esta tarefa termina |
dueBy | number | epoch ms | data e hora limite para a conclusão desta tarefa |
startedAt | number | epoch ms | data e hora em que a tarefa foi efetivamente iniciada |
completedAt | number | epoch ms | data e hora em que a tarefa foi efetivamente concluída |
cancelledAt | number | epoch ms | data e hora em que a tarefa foi cancelada |
procedure | string | uuid | id do procedimento ao qual esta tarefa pertence |
task | string | uuid | id da tarefa à qual esta tarefa está associada |
entity | string | uuid | id da entidade do registro à qual esta tarefa está associada |
record | string | uuid | id do registro ao qual a tarefa está associada |
form | string | uuid | id do formulário ao qual esta tarefa está associada |
membros | json |
| lista de IDs de usuários que também são participantes da tarefa |
dados | json |
| objeto JSON id:value que armazena os dados reais |
derivedData | json |
| objeto JSON id:value que armazena os dados derivados |
createdAt | number | epoch ms | carimbo de data e hora em que a tarefa foi criada |
updatedAt | number | epoch ms | carimbo de data e hora em que a tarefa foi atualizada |
isDeleted | booleano |
| indicador que informa se esta tarefa foi excluída ou não |