Para que serve?
Serve para consultar as atividades em andamento e que estão sob responsabilidade do usuário da API.
Quando usar?
Esse serviço geralmente é utilizado para consultar atividades em andamento para:
- Exibir atividades pendentes numa interface específica (aplicação externa);
- Executar uma atividade de forma automática em robôs (realizar aprovação ou rejeição);
- Aprovar automaticamente através de robô uma atividade de ciência;
- Enviar e-mail personalizado;
- Realizar distribuição de atividades em cenários complexos de roteamento;
- Atualizar dados específicos da atividade.
Como usar?
Esse serviço retorna todas as atividades em andamento sob responsabilidade do usuário da API. É possível restringir a consulta através de diversos filtros, conforme a necessidade.
Esse serviço retorna uma lista paginada. Assim, é possível informar a quantidade de linhas por página e a página que deseja ser consultada, cuja numeração de página começa em zero. Entretanto, essas informações não são obrigatórias para a pesquisa. Nessa situação, isto é, se não informar a quantidade de linhas por página e a página, os 20 primeiros dados serão retornados.
O campo resultFields funciona de maneira distinta para diferentes tipos de valores. Quando se trata de valores do tipo texto, caso múltiplos valores sejam declarados na requisição, o serviço considera apenas o primeiro valor informado. Já para valores numéricos (campos inteiros, decimais e monetários), a rota aplica uma lógica de filtragem com base em um intervalo, realizando um "between" entre o menor e o maior valor declarado. Dessa forma, o sistema compara o valor armazenado no formulário com esse intervalo e, se ele estiver dentro dos limites, a atividade pendente será apresentada no retornado do serviço.
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Links das APIs
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v4 | Documentação Técnica | 6.00 RTM 1.00 | 🟢 | |
| v3 | Documentação Técnica | 5.60 RTM 1.02 | 🟡 | |
| v2 | Documentação Técnica | 5.60 RTM 1.00 | 🟡 | |
| v1 | Documentação Técnica | 5.50 RTM 1.06 | 🟡 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada