APIs - Tutoriais

CancelProcessInstance

45 views 18/06/2021 21/06/2021 alex-serodio 0

CancelProcessInstance

Cancela uma lista de processos que estejam em andamento.

Payload de entrada:

{
    "ids": [ 1, 2 ],        // identificadores das instâncias de processos
    "user": "string",       // usuário responsável pelo cancelamento, deve ser informado quando for uma aplicação, quando não for aplicação esse campo é ignorado (opcional)
    "reason": "string"      // motivo do cancelamento
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/actions/cancelProcessInstance" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'ids': [ 1, 2 ], user': 'Nome do usuário', 'reason': 'O solicitante optou por não dar continuidade ao processo.' }"

Responses:

  • 200 OK
    {}
  • 400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados, campo informado incorretamente ou caso a instância de processo informada não exista ou já tenha sido finalizada
    {
       "message": "Descrição do erro",
       "errorCode": "codigoDoErro",
       "reason": "BAD_REQUEST",
       "domain": "platform",
       "service": "workflow"
    }
  • 401 Unauthorized: Usuário ou senha inválido
    {
       "error_description": "Descrição do erro",
       "error": "codigo_do_erro"
    }

Este artigo foi útil para você?