API Reference

Release Notes

Acompanhe a evolução dos nossos serviços.

VERSÃO 6.00 RTM 1.00

Data: 06/12/2024

Foram disponibilizados e ajustados os seguintes serviços:

SessãoServiçoVersãoObservações
ProcessosAbrir processov1Ajustado no payload a apresentação da mensagem de validação quando o processo está em um modo diferente do modo declarado na requisição desse serviço
ProcessosAlterar prazos (SLA) de uma atividadev2Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosAprovar ou rejeitar atividadev1, v2Incluído no payload do serviço a apresentação da informação dos campos processId, versionId, processInstanceId e uuId
ProcessosAprovar ou rejeitar atividadev1Serviço depreciado
ProcessosAtualizar dados da atividadev2Retirada a duplicação do campo Lista no payload quando o serviço é executado
ProcessosCalcular o tempo útil para cálculo de prazos da atividadev1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosCancelar processov1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosConsultar atividades pendentes por usuáriov4Implementado o campo activityInstanceId para consulta a partir da atividade do processo e normalização das descrições dos campos processId e version na documentação técnica do serviço.
ProcessosConsultar atividades pendentes por usuáriov3Serviço depreciado
ProcessosConsultar atividades pendentes por usuáriov2, v3Normalizamos as descrições dos campos processId e version na documentação técnica do serviço.
ProcessosEncaminhar atividadesv1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosIncluir responsável em uma atividadev1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosListar atividades dos processos abertos pelo usuáriov2Novo Serviço
ProcessosListar definições de campos do processov4Novo Serviço
ProcessosListar processos que o usuário pode abrirv3Incluídos os campos categoryId e categoryName como filtros para a consulta de processos. Esses novos campos agora também são exibidos na resposta do serviço.
ProcessosListar processos que o usuário pode abrirv2Serviço depreciado
ProcessosObter as atividades do processov5Incluído no payload do serviço a apresentação da informação dos campos phaseId e phase.
ProcessosObter as atividades do processov4Serviço depreciado.
ProcessosObter as fases do processov2Novo Serviço
ProcessosObter atividades da fase do processov2Novo Serviço
ProcessosObter as informações gerais do processov4Normalizamos as descrições dos campos processId e version na documentação técnica do serviço.
ProcessosRemover responsável em uma atividadev1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
ProcessosRemover uma atividade da hibernaçãov1Foi concedida uma nova permissão para que os usuários realizem o encaminhamento de atividades, uma função que anteriormente era exclusiva do gestor de processos.
AdminAtualizar os dados do usuáriov4Novo Serviço
AdminCriar usuáriov5Incluídos os campos forwardActivities, removeHibernation, changeSLA e cancelProcesses no body params e no payload do serviço. Tais campos dão permissão ao usuário realizar ações permitidas para o usuário gestor do processo.
AdminCriar usuáriov4Serviço depreciado
AdminEditar usuáriov5Incluídos os campos forwardActivities, removeHibernation, changeSLA e cancelProcesses no body params e no payload do serviço. Tais campos dão permissão ao usuário realizar ações permitidas para o usuário gestor do processo.
AdminEditar usuáriov4Serviço depreciado.
AdminObter informações do usuáriov5Incluídos os campos forwardActivities, removeHibernation, changeSLA e cancelProcesses no body params e no payload do serviço. Tais campos dão permissão ao usuário realizar ações permitidas para o usuário gestor do processo.
AdminObter informações do usuáriov4Serviço depreciado
DocumentosListar dossiêsv1Novo Serviço

VERSÃO 5.70 RTM 1.00.1

Data: 11/04/2024

Foram disponibilizados e ajustados os seguintes serviços:

SessãoServiçoVersãoObservações
ProcessosObter as atividades do processov4Incluídos no retorno do serviço os campos "owner", "ownerId" para informar o responsável pela atividade executada.

VERSÃO 5.70 RTM 1.00

Data: 09/02/2024

Foram disponibilizados e ajustados os seguintes serviços:

SessãoServiçoVersãoObservações
ProcessosAlterar prazos (SLA) de uma atividadev2Novo serviço
ProcessosCalcular o tempo útil para cálculo de prazos da atividadev1Novo serviço
ProcessosIncluir responsável em uma atividadev1Novo Serviço
ProcessosObter as atividades do processov4Novo serviço
ProcessosObter as informações gerais do processov4Novo serviço
ProcessosObter os responsáveis em uma atividadev1Novo Serviço
ProcessosRemover uma atividade da hibernaçãov1Novo serviço
ProcessosRemover responsável em uma atividadev1Novo serviço
AdminCriar departamentov2Depreciada
AdminCriar departamentov3Aumentamos a quantidade de caracteres permitidos para declaração do nome do departamento (Até 70 caracteres)
AdminCriar funçãov2Depreciada
AdminCriar funçãov3Aumentamos a quantidade de caracteres permitidos para declaração do nome da função (Até 70 caracteres)
AdminCriar usuáriov3Depreciada
AdminCriar usuáriov4Implementada a configuração de acesso do usuário a partir do fator múltiplo de autenticação (MFA)
AdminEditar departamentov2Depreciada
AdminEditar departamentov3Aumentamos a quantidade de caracteres permitidos para declaração do nome do departamento (Até 70 caracteres)
AdminEditar funçãov2Depreciada
AdminEditar funçãov3Aumentamos a quantidade de caracteres permitidos para declaração do nome da função (Até 70 caracteres)
AdminEditar usuáriov3Depreciada
AdminEditar usuáriov4Implementado a configuração de acesso do usuário a partir do fator múltiplo de autenticação (MFA)
AdminListar usuáriov3Depreciada
AdminListar usuáriov4Inserido o campo cellphone para pesquisa de usuário a partir do celular e retirado do campo authenticationType o valor referente a autenticação BPM
AdminObter informações do usuáriov3Depreciada
AdminObter informações do usuáriov4Incluído no payload do serviço a apresentação da informação do campo fator múltiplo de autenticação.
DocumentosObter informações do tipo de documento (template)v3Novo serviço
DocumentosDownload de documentov1Novo serviço
DocumentosExcluir documentov1Novo serviço
DocumentosIncluir documentov1Novo serviço
DocumentosListar documentosv1Novo serviço
DocumentosObter definições de campos específicos do tipo de documento (template)v3Novo serviço
DocumentosObter definições de campos de metadados do templatev3Novo serviço
DocumentosObter informações de um documentov1Novo serviço
DocumentosObter informações dos metadados do documentov2Novo serviço
DocumentosObter versões de um documentov1Novo serviço
DocumentosSubstituir documentov1Novo serviço

VERSÃO 5.60 RTM 1.02

Data: 07/07/2023

Foram disponibilizados e ajustados os seguintes serviços:

SessãoServiçoVersãoObservações
ProcessosAprovar ou rejeitar atividadev2Normalizamos as informações dos campos apresentados no retorno do serviço (payload) e na documentação técnica do serviço (integration, activityType, isSubProcess, name)
ProcessosConsultar atividades pendentes por usuáriov3Incluímos novos campos no retorno do serviço (payload) e na documentação técnica (activityStartDate, status, openedByUser, openedById)
ProcessosListar pendências do usuário agrupadas por processov1Novo serviço
ProcessosListar processos que o usuário pode abrirv2Incluímos na documentação técnica o campo "categories".
ProcessosObter informações dos campos de resultado da atividadev1Novo serviço
AdminCriar apikey para um usuáriov1Novo serviço
AdminCriar usuáriov3Ajustamos o envio da requisição referente ao campo "language" para não aceitar valor nulo e retiramos a informação "login" da documentação técnica pois não é apresentado no retorno do serviço (payload).
AdminEditar usuáriov3Retiramos a obrigatoriedade do campo "idSubstitute" e retiramos a informação "login" da documentação técnica, pois não é apresentado no retorno do serviço (payload).
AdminListar usuáriosv4Adicionamos filtro do número de celular existente no cadastro de usuário e retiramos a informação "BPM" da lista de valores do campo authenticationType e de sua descrição.
AdminRevogar apikey para um usuáriov1Novo serviço

VERSÃO 5.60 RTM 1.01

Data: 05/06/2023

Foram disponibilizados os seguintes serviços:

SessãoServiçoVersãoObservações
AdminCriar departamentov2
AdminCriar funçãov2
AdminEditar departamentov2

VERSÃO 5.60 RTM 1.00

Data: 26/04/2023

Foram disponibilizados os seguintes serviços:

VERSÃO 5.50 RTM 1.06

Data: 24/11/2022

Foram disponibilizados os seguintes serviços: