v1Recursos/Approvals/getObter uma tarefa
Obter uma tarefa
Retorna uma tarefa ou subtarefa de Tarefas e aprovações pelo id: status, responsável, estado de aprovação, datas e rowVersion. Uma tarefa que não existe, ou que pertence a um cliente fora do acesso da chave, retorna 404. Se Tarefas e aprovações não estiver ativado no seu workspace, retorna 404.
get
approvals:read/api/v1/work-management/tasks/{id}Parâmetros de consulta
idstringobrigatório
O id da tarefa, um UUID. Qualquer outro valor retorna 404.
Resposta
okbooleanopcional
Sempre true em uma resposta bem-sucedida.
deliveryAvailablebooleanopcional
Se este workspace pode entregar conteúdo aprovado. Pode estar ausente.
itemobjectopcional
A tarefa.
keystringopcional
A chave da tarefa, no formato task:<id>.
itemIdstringopcional
O id da tarefa.
kindstring (task | subtask)opcional
task para uma tarefa principal, subtask para uma subtarefa.
titlestringopcional
O título da tarefa.
descriptionstringopcional
A descrição da tarefa, ou null.
statusstring (open | in_progress | awaiting_decision | approval_required | revision_requested | approved | rejected | done | dismissed)opcional
Em que ponto a tarefa está. approval_required significa que ela aguarda o aprovador.
clientIdstringopcional
O cliente da tarefa, ou null para trabalho da agência.
locationIdstringopcional
O local ao qual a tarefa se refere, ou null.
projectIdstringopcional
O projeto ao qual a tarefa pertence, ou null.
projectNamestringopcional
O nome do projeto, ou null.
parentKeystringopcional
Em uma subtarefa, a chave da tarefa principal; caso contrário, null.
ownersarray of objectopcional
O responsável pela tarefa, em forma de lista. Tarefas novas têm no máximo um; tarefas mais antigas ainda podem mostrar vários.
idstringopcional
O id da pessoa. Envie-o como ownerId ao criar uma tarefa, ou como userId ao definir um responsável.
namestringopcional
O nome de exibição da pessoa.
typestring (user | client_user)opcional
user para um membro da equipe da agência, client_user para uma pessoa de um cliente. Envie o mesmo valor como ownerType.
avatarUrlstringopcional
A URL da foto de perfil da pessoa, se houver.
creatorobjectopcional
Quem criou a tarefa: um membro da equipe ou um usuário de cliente. null quando desconhecido.
idstringopcional
namestringopcional
typestring (user | client_user)opcional
manualApprovalobjectopcional
O aprovador da tarefa e o estado da solicitação de aprovação.
approverobjectopcional
O id, o nome e o tipo do aprovador, ou null quando não houver.
statestring (approval_required | approved)opcional
approval_required enquanto uma solicitação aguarda o aprovador, approved depois de aprovada; caso contrário, null.
requestIdstringopcional
O id da solicitação de aprovação pendente, ou null.
feedbackstringopcional
O motivo do aprovador quando pediu alterações, enquanto a tarefa está aberta de novo. Caso contrário, null.
detailsobjectopcional
Etiquetas, data de início, estimativa de tempo e arquivos anexados.
labelsarray of stringopcional
startDatestringopcional
estimatedMinutesintegeropcional
attachmentsarray of objectopcional
keystringopcional
namestringopcional
mimestringopcional
sizeintegeropcional
prioritystring (urgent | high | medium | low)opcional
A prioridade da tarefa, ou null.
dueAtstringopcional
Quando a tarefa vence, em UTC, ou null.
createdAtstringopcional
Quando a tarefa foi criada, em UTC.
updatedAtstringopcional
Quando a tarefa mudou pela última vez, em UTC.
completedAtstringopcional
Quando a tarefa foi concluída, em UTC, ou null.
blockedByarray of stringopcional
Chaves de itens abertos que precisam ser concluídos antes desta tarefa.
openSubtaskCountintegeropcional
Quantas de suas subtarefas ainda estão abertas.
commentCountintegeropcional
Quantos comentários a tarefa tem.
rowVersionintegeropcional
O número de versão da tarefa. Aumenta sempre que a tarefa é editada.
Erros
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.
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.
get/api/v1/work-management/tasks/{id}
Sua chave de API
id *
{}