Gerenciar tarefas pela API

Preparar a integração de tarefas

1. 1

   Acesse Configuração > API e confirme a credencial destinada ao sistema consumidor.

2. 2

   Copie a URL base e o ApiID do ambiente de homologação.

3. 3

   Envie o token no cabeçalho Authorization com o esquema Bearer.

4. 4

   Use Content-Type application/json nas requisições em que um corpo for enviado.

5. 5

   Escolha um usuário e uma tarefa de teste que possam ser alterados e excluídos sem afetar a operação.

Listar tarefas e consultar logs

• GET /v2/api/external/{ApiID}/todo/list lista tarefas e recebe apenas ApiID como string obrigatória no caminho.
• A rota de listagem não publica filtros, paginação ou parâmetros de busca.
• GET /v2/api/external/{ApiID}/todo/logs/{userId} consulta logs e recebe ApiID e userId como strings obrigatórias no caminho.
• Os logs são consultados por userId, não pelo ID da tarefa.

1. 1

   Liste as tarefas e identifique um registro de homologação.

2. 2

   Confirme na interface o nome, responsável, prioridade e status desse registro.

3. 3

   Consulte os logs com o userId correto e observe o formato devolvido sem copiar dados pessoais para o log da integração.

4. 4

   Guarde apenas os IDs necessários para as próximas operações.

Criar uma tarefa com os campos publicados

• POST /v2/api/external/{ApiID}/todo/create recebe ApiID como string obrigatória no caminho.
• O corpo publica name, description, owner, ownerId, status e priority, todos do tipo string.
• O schema não marca nenhuma dessas propriedades nem o próprio corpo como obrigatórios.
• O contrato não define valores permitidos para status e priority nem explica a relação entre owner e ownerId.

1. 1

   Consulte tarefas e usuários antes da criação para observar os identificadores e valores realmente usados pelo ambiente.

2. 2

   Monte o corpo somente com os seis campos publicados e dados fictícios.

3. 3

   Envie uma única solicitação de criação.

4. 4

   Liste novamente e confirme se a tarefa foi criada uma única vez.

5. 5

   Compare o registro com a interface antes de liberar o fluxo para produção.

Atualizar somente o status documentado

• POST /v2/api/external/{ApiID}/todo/update/{id} recebe ApiID e id como strings obrigatórias no caminho.
• O corpo publicado contém apenas status do tipo string.
• O schema não marca status nem o próprio corpo como obrigatórios e não apresenta enumeração de valores.
• Não envie name, description, owner, ownerId ou priority por analogia com a criação; esses campos não aparecem no contrato de atualização.

1. 1

   Liste as tarefas e confirme o id do registro de homologação.

2. 2

   Observe um valor de status aceito pela versão atual sem presumir equivalência com o rótulo visual.

3. 3

   Atualize o status uma única vez.

4. 4

   Liste novamente e confirme a alteração na interface.

5. 5

   Se houver timeout, reconcilie o estado antes de tentar novamente.

Excluir uma tarefa com confirmação

• POST /v2/api/external/{ApiID}/todo/delete/{id} recebe ApiID e id como strings obrigatórias no caminho.
• A exclusão usa o método POST, não DELETE.
• O schema do corpo é um objeto sem propriedades e o próprio corpo não aparece marcado como obrigatório.
• Não há restauração, lixeira ou rollback descritos no contrato publicado.

1. 1

   Liste e selecione apenas a tarefa descartável de homologação.

2. 2

   Registre a autorização para exclusão sem copiar a descrição completa da tarefa.

3. 3

   Execute a rota uma única vez.

4. 4

   Liste novamente e confira a ausência do registro também na interface.

Separar recursos da interface e contrato da API

A interface de tarefas pode apresentar comentários, prazo, recorrência e outras ações. Esses recursos não aparecem nos campos publicados pelas cinco rotas deste guia e não devem ser anunciados como disponíveis pela API sem um contrato específico.

• Criação: somente name, description, owner, ownerId, status e priority estão publicados.
• Atualização: somente status está publicado.
• Listagem: não há filtros nem paginação documentados.
• Logs: a consulta exige userId e não recebe o ID da tarefa.
• Respostas: há apenas HTTP 200 com JSON sem schema, sem códigos de erro, exemplos, idempotência ou limites de uso.

• Lista vazia: confirme URL base, ApiID, token e permissões do mesmo ambiente.
• Responsável divergente: não presuma o significado de owner ou ownerId; compare o retorno de homologação com a interface.
• Status recusado: valide o valor aceito pela versão atual e não traduza automaticamente o rótulo visual.
• Registro duplicado: interrompa retentativas e reliste antes de criar novamente.
• Resposta 200 inconclusiva: valide a tarefa na listagem e na interface.