Novas APIs do mês de julho

versão 4.26 Julho chegou, friozinho, cobertor, filmes e novas APIs!


A sigla API deriva da expressão inglesa Application Programming Interface que, traduzida para o português, pode ser compreendida como uma interface de programação de aplicação. Ou seja, API é um conjunto de padrões que possibilita a comunicação entre sistemas diferentes através de uma série de protocolos. Ou seja, disponibilizando novas APIs estamos permitindo que você e seus outros sistemas se comunicam com o Zeev mais facilmente!


Vamos conhecer as novas APIs?

Nova API para finalizar tarefa atribuída a usuário por código identificador da Instância e apelido da atividade 

PUT /API/2/ASSIGNMENTS/INSTANCE/{INSTANCEID}/{CODE}

Nossa, que complicado! Péra, não é tão complicada assim. Essa API permite:

  • Finalizar uma tarefa em andamento
  • Passando o número da solicitação

Mas isso não existia antes? Não existia; para finalizar uma tarefa pendente, você tinha que passar o número da tarefa, uma informação menos "pública" que o número da solicitação. Mas, como o sistema vai saber qual tarefa finalizar, se existir mais de 1 pendente? Excelente pergunta! 

Cada tarefa pode possuir um apelido, um nome amigável que você define quando está construindo o processo. 


Então, para usar essa API, além do número da solicitação, você vai ter que enviar o apelido da tarefa. Se o sistema encontrar uma tarefa pendente com esse apelido, voilá, ela será finalizada!

Nova API para permitir listar usuários por time, por função ou por ambos

GET /api/2/positions/code/{positioncode}/users

GET /api/2/teams/code/{teamcode}/users

GET /api/2/teams/code/{teamcode}/{positioncode}/userS

Trata-se, na verdade, de um conjunto de novas APIs. São bem simples. 

Elas permitem listar todos os usuários que fazem parte de um determinado time.

Ou todos os usuários que fazem possuem uma certa função.

Ou todos os usuários que fazem parte de um time com uma certa função.


APIs para listar as atividades já concluídas de uma solicitação

GET /api/2/instances

GET /api/2/instances/{instanceid}

POST /api/2/instances/report

Nesse caso não é uma API nova. As APIs acima já existiam.  O que foi incluído é um novo parâmetro de consulta (opcional) que permite listar todo o histórico de atividades já concluídas de cada solicitação. Muito importante se você pensa em montar algum tipo de BI com os dados históricos!