v1Recursos/Approvals/postCriar uma tarefa
Criar uma tarefa
Cria uma tarefa em Tarefas e aprovações. Uma tarefa é um trabalho que sua equipe acompanha para um cliente, ou para a própria agência quando você omite clientId. Na mesma chamada, você pode definir um responsável, um aprovador e até 25 subtarefas; as subtarefas adicionadas aqui copiam o responsável, o aprovador, a prioridade e as datas da tarefa, a menos que você defina os delas. Para criar uma subtarefa de uma tarefa aberta existente, envie parentTaskId. Quando o responsável é um usuário de cliente e você omite clientId, a tarefa é criada para o cliente desse usuário. Repetir é seguro: enviar o mesmo idempotencyKey com o mesmo corpo retorna o primeiro resultado com replayed igual a true, e reutilizar uma chave com outro corpo retorna 409. Se Tarefas e aprovações não estiver ativado no seu workspace, retorna 404.
post
approvals:write/api/v1/work-management/tasksCorpo da solicitação
idempotencyKeystringobrigatório
Uma string única que você escolhe, de 8 a 200 caracteres. Reutilize-a apenas para repetir a mesma solicitação.
clientIdstringopcional
O cliente da tarefa. Omita ou envie null para trabalho da agência. Com uma chave que alcança todos os clientes, aceita o id, o id público ou o slug do cliente. Com uma chave limitada a clientes específicos, passe o id do cliente; qualquer outro valor, ou um cliente fora do acesso da chave, retorna 403. Uma subtarefa sempre compartilha o cliente da tarefa principal, e indicar outro retorna 400.
titlestringobrigatório
O título da tarefa, até 500 caracteres.
descriptionstringopcional
O que precisa ser feito, até 20.000 caracteres.
locationIdstringopcional
Um local do cliente da tarefa ao qual a tarefa se refere. Um local de outro cliente retorna 400.
projectIdstringopcional
Um projeto do mesmo cliente no qual agrupar a tarefa.
parentTaskIdstringopcional
Cria esta tarefa como subtarefa de uma tarefa existente. A tarefa principal precisa estar aberta e não pode ser uma subtarefa. A nova subtarefa recebe o responsável, o aprovador, o projeto, o local, a prioridade, a data de vencimento e a data de início da principal, a menos que você envie os seus. Não pode ser combinado com subtasks.
metaobjectopcional
Prioridade e data de vencimento. Envie os dois campos juntos. O padrão é prioridade medium e sem data de vencimento.
prioritystring (urgent | high | medium | low)obrigatório
O quanto a tarefa é urgente.
dueDatestringobrigatório
Data de vencimento no formato YYYY-MM-DD no fuso horário do seu workspace, ou null.
detailsobjectopcional
Etiquetas, data de início e estimativa de tempo.
labelsarray of stringopcional
Até 10 etiquetas de 40 caracteres cada. Duplicatas que diferem apenas em maiúsculas e minúsculas são unificadas.
startDatestringopcional
Data de início no formato YYYY-MM-DD, ou null. Não pode ser posterior à data de vencimento.
estimatedMinutesintegeropcional
Esforço estimado em minutos, ou null.
subtasksarray of objectopcional
Até 25 subtarefas para criar junto com a tarefa. Cada uma copia o responsável, o aprovador, a prioridade, a data de vencimento e a data de início da tarefa, a menos que você defina os dela.
titlestringobrigatório
O título da subtarefa, até 200 caracteres.
descriptionstringopcional
O que a subtarefa abrange, até 20.000 caracteres.
ownerIdstringopcional
O responsável pela subtarefa. Omita para copiar o da tarefa, ou envie null para não ter responsável.
ownerTypestring (user | client_user)opcional
Se o responsável é um membro da equipe da agência (user) ou um usuário de cliente (client_user). O padrão é user.
approverIdstringopcional
O aprovador da subtarefa. Omita para copiar o da tarefa, ou envie null para nenhum.
dueDatestringopcional
Data de vencimento da subtarefa no formato YYYY-MM-DD, ou null.
startDatestringopcional
Data de início da subtarefa no formato YYYY-MM-DD, ou null.
prioritystring (urgent | high | medium | low)opcional
A prioridade da subtarefa.
ownerIdstringopcional
O id da pessoa responsável pela tarefa, obtido em GET /api/v1/work-management/owners. Envie null para não ter responsável. Em uma subtarefa, omitir copia o responsável da principal.
ownerTypestring (user | client_user)opcional
Se o responsável é um membro da equipe da agência (user) ou um usuário de cliente (client_user). O padrão é user.
approverIdstringopcional
O id de um membro da equipe da agência que aprova o trabalho da tarefa quando alguém solicita aprovação. Envie null para nenhum.
Resposta
okbooleanopcional
Sempre true em uma resposta bem-sucedida.
dataobjectopcional
keystringopcional
A chave da tarefa, no formato task:<id>.
rowVersionintegeropcional
O número de versão da tarefa. Aumenta sempre que a tarefa é editada.
replayedbooleanopcional
true quando esta resposta repete uma solicitação anterior com o mesmo idempotencyKey, então nada novo foi salvo.
Erros
400Os erros de Tarefas e aprovações retornam ok: false com um objeto error contendo code, message, retryable e details. Os erros da própria verificação da chave de API (chave ausente ou inválida, scope ausente, limite de requisições) usam o formato padrão, em que error é uma string.
401Chave de API ausente, inválida, expirada ou revogada.
403Os erros de Tarefas e aprovações retornam ok: false com um objeto error contendo code, message, retryable e details. Os erros da própria verificação da chave de API (chave ausente ou inválida, scope ausente, limite de requisições) usam o formato padrão, em que error é uma string.
404Os erros de Tarefas e aprovações retornam ok: false com um objeto error contendo code, message, retryable e details. Os erros da própria verificação da chave de API (chave ausente ou inválida, scope ausente, limite de requisições) usam o formato padrão, em que error é uma string.
409Os erros de Tarefas e aprovações retornam ok: false com um objeto error contendo code, message, retryable e details. Os erros da própria verificação da chave de API (chave ausente ou inválida, scope ausente, limite de requisições) usam o formato padrão, em que error é uma string.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
500Não foi possível concluir a requisição por um problema do nosso lado.
post/api/v1/work-management/tasks
Sua chave de API
Corpo da solicitação*
{}