O CAP Workflow possui interfaces disponibilizadas em forma de Web Services com métodos para algumas das operações comuns, como pesquisa de solicitações e criação de novas solicitações. Outros métodos para extensões e personalizações do produto através de regras de negócio específicas também se encontram nesta interface, como a possibilidade de atualizar o SLA de uma tarefa ou de uma solicitação (SLA Dinâmico).
On Premises
Conforme o CAP foi evoluindo essas API's sofreram algumas mudanças de endereço, por exemplo, a partir da versão do CAP Workflow 2016 (3.8.x / 4.8.x), o endereço de acesso à interface também possui a versão do produto. Esta adição foi implementada para possibilitar instalações lado-a-lado de diferentes versões do CAP Workflow na mesma farm SharePoint, cada uma com a sua própria interface. Note que este endereço poderá ser generalizado a partir da criação de um novo diretório virtual no IIS para que possíveis personalizações do produto que utilizem esta interface possam ser atualizadas com versões posteriores do CAP sem a necessidade de alterações nas referências das interfaces utilizadas pelas personalizações. Em caso de dúvidas de como realizar este procedimento, entre em contato com o suporte do produto.
Cloud
Até a versão 4.8.x, o endereço seguia a mesma regra do on premises (acima), mas a partir da versão 5.0.x (codinome CAP SPS), muita coisa mudou. Agora o endereço fica assim: https://empresa.capworkflow.com/services/CAPRequests.asmx
Como me autenticar?
FBA - Forms-Bases Authentication
ADFS / Azure AD
Quais são as API's Nativas do CAP?
CompleteTask
Completa tarefas informando, entre outros parâmetros, o usuário, o resultado e os valores para os metadados.
CreateRequest
Cria novas solicitações informando, entre outros parâmetros, o solicitante e os valores para os metadados.
CreateUser
Cria um usuário no CAP (somente se o método de autenticação for FBA - Forms Based Authenticaton).
GetRequests
Obtém as solicitações utilizando filtros de forma análoga à tela de Pesquisa de Solicitações do CAP.
GetRequestDetails
Busca as informações de uma solicitação específica.
UpdateSLA
Atualiza o SLA corrente de uma Solicitação. Muito utilizado para tornar um SLA dinâmico conforme uma regra de negócios. Exemplo: Por padrão o SLA de uma tarefa é de 8 horas, mas se o campo cliente VIP estiver "checked", é possível mudar o SLA dinamicamente para 1 hora.
UpdateTaskSLAByOrder
A mesma coisa do UpdateSLA, mas atualiza o SLA corrente de uma Tarefa localizada através da Ordem de Execução.
UpdateTaskSLAByTitle
A mesma coisa do UpdateSLA, mas atualiza o SLA corrente de uma Tarefa localizada através do Título da Tarefa.