Português
English
GetProcessesList
Obtém todos os processos que o usuário autenticado tem algum tipo de permissão.
Payload de entrada
{
// tipo de ação que indica quais processos serão listado. Pode ser UserGrantedProcesses, UserGrantedCordinateProcesses, AllProcesses ou UserGrantedOrEditProcesses
"serviceAction": "AllProcesses",
// filtro por tipo de processo. Pode ser Embedded, NotEmbedded ou All (opcional)
"processFilterType": "Embedded",
// para filtrar por categoria (opcional)
"tagFilter": "string",
// apenas retorna processos ativos ou inativos (opcional)
"onlyActiveProcesses": true,
// data a partir de qual deve buscar eventos de serviços externos (opcional)
"serviceEventStartDate": "2021-06-16T20:35:00Z"
}
Request
curl --location --request POST "https://api.senior.com.br/platform/workflow/getProcessesList" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'serviceAction': 'AllProcesses', 'processFilterType': 'Embedded', 'tagFilter': 'contratos', 'onlyActiveProcesses': true, 'serviceEventStartDate': '2021-06-16T20:35:00Z' }"
Response
200 Ok
{
"processes": [
{
// identificador do processo
"processId": 0,
// versão atual do processo
"currentVersion": 0,
// versão publicada do processo
"publishedVersion": 0,
// nome do processo
"processName": "string",
// nome do processo assim como se encontra no banco de dados
"processRawName": "string",
// se o processo está modificado
"changed": true,
// nome do arquivo do processo
"fileName": "string",
// se o processo esta publicado ou apenas salvo. Pode ser Saved ou Published
"status": "Saved",
// descrição do processo
"description": "string",
// data de criação do processo
"creationDate": "2021-06-19T18:13:16.297Z",
// se o processo está ativo
"active": true,
// se o processo é embarcado
"embedded": true,
// se o processo é simples
"simple": true,
// tag agrupador de processos
"tag": "string",
// indica o nível de acesso do usuário ao processo. Pode ser EDIT_AND_START, START, EDIT ou NONE
"accessLevel": "EDIT_AND_START",
// ícone do processo
"icon": "string",
// listagem dos tipos e quantidade de eventos de serviço externo
"serviceEventQtyByType": [
{
// tipo do evento
"type": "IN_PROGRESS",
// quantidade de eventos
"quantity": 0
}
]
}
]
}
OBS: processes pode conter um único item como no exemplo ou uma lista desses itens.
400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente
{
"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"
}
