Pular para o conteúdo

Buscar um template por ID, com o rascunho para aplicá-lo

GEThttps://api.azzimuti.com.br/v1/templates/{id}

RECIPES

Parâmetros de path

  • idstringobrigatóriouuid

    ID do template

Respostas

200Template encontrado com sucesso

Corpo da resposta

application/json

  • idstringobrigatóriouuid

    ID do template

  • numbernumberobrigatório

    Número do template

  • titlestringobrigatório

    Título do template

  • descriptionstringobrigatóriopode ser nulo

    Descrição do template (HTML)

  • kindstringobrigatório

    Tipo do template: de tarefa (TASK) ou de projeto (PROJECT)

    Valores permitidos:TASKPROJECT
  • departmentIdstringobrigatóriouuid

    ID do espaço do template

  • departmentGroupIdstringobrigatóriouuidpode ser nulo

    ID do sub-espaço (grupo) do template

  • prioritynumberobrigatório

    Prioridade sugerida (1 a 10)

  • userExecutorIdstringobrigatóriouuidpode ser nulo

    ID do executor sugerido

  • suggestedDaysnumberobrigatóriopode ser nulo

    Prazo sugerido, em dias corridos a partir da aplicação do template

  • createdAtstringobrigatóriodate-time

    Data de criação do template

  • draftobjectobrigatório

    Rascunho para aplicar o template, com o prazo (endedAt) já calculado a partir de agora. Template de tarefa: { task: {...} }; de projeto: { project: { ..., tasks: [...] } }. Envie o templateId no corpo do POST de criação para registrar a origem (o uso conta no histórico e nas métricas do template). Não é enviado tal qual para a criação: (1) use o conteúdo de task/project, não o envelope; (2) POST /v1/tasks exige userExecutorId (pode vir nulo aqui) e ignora openReview, attachments e, no checklist, assigneeId e children (os subitens não são criados); (3) POST /v1/projects exige userExecutorId, description, endedAt, priority e isReadyToClose (os dois últimos não vêm no rascunho; os demais podem vir nulos) e userReviewerId quando openReview é verdadeiro; seu tasks é uma lista de IDs de tarefas já existentes — crie antes cada item de project.tasks via POST /v1/tasks (no espaço do projeto) e envie os IDs; attachments também é ignorado. Anexos vêm só como referência (URL).

Exemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": 0,
  "title": "string",
  "description": "string",
  "kind": "TASK",
  "departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "departmentGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "priority": 0,
  "userExecutorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "suggestedDays": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "draft": {}
}
404Template não encontrado

Sem corpo de resposta.

Linguagem

Credenciais

Bearer
Bearer
curl --request GET \
     --url https://api.azzimuti.com.br/v1/templates/id \
     --header 'accept: application/json'

Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui

Ou escolha um exemplo:

application/json