APIs de processo de fluxo de trabalho

Use APIs de REST do Processo para automatizar ações em processos e tarefas em automações de fluxo de trabalho.

É possível acessar a definição de Swagger para as APIs diretamente a partir da visualização Construção.

Importante: para evitar ataques de falsificação de solicitações entre sites, as operações da API REST exigem que o cabeçalho HTTP BPMCSRFToken seja definido em todas as solicitações.

O aplicativo cliente deve obter o token necessário chamando a API de REST POST /system/login com um body JSON que é semelhante ao exemplo a seguir.

{
  "refresh-groups": false,
  "requested-lifetime": 7200
}

Se você definir o valor da propriedade refresh-groups como false, isso evitará as sobrecargas associadas à atualização da associação ao grupo para o usuário responsável pela chamada. A propriedade requested_lifetime define o número de segundos de validade do token. Se um valor não for especificado, o valor padrão de 7200 segundos será usado, que é o valor máximo permitido. Deve-se sempre enviar uma carga útil com a chamada, mesmo que esteja vazia.

O token é retornado como uma sequência na propriedade csrf_token do objeto de resposta.

Se uma chamada contiver um token expirado, ela falhará com o código de resposta HTTP 403 e o erroCWTBG0651E: The request was blocked because the BPMCSRFToken token header could not be verified.na resposta. Para recuperar um novo token, o aplicativo cliente deve chamar a API POST /system/login novamente. O aplicativo cliente pode então utilizar o novo token para reenviar a solicitação com falha.

Para obter mais informações, consulte Recursos da API REST do fluxo de trabalho