APIs - Tutoriais

GetProcessesList

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

GetProcessesList

Obtém todos os processos que o usuário autenticado tem algum tipo de permissão.

Payload de entrada:

{
    "serviceAction": "AllProcesses",                // tipo de ação que indica quais processos serão listado. Pode ser UserGrantedProcesses, UserGrantedCordinateProcesses, AllProcesses ou UserGrantedOrEditProcesses
    "processFilterType": "Embedded",                // filtro por tipo de processo. Pode ser Embedded, NotEmbedded ou All (opcional)
    "tagFilter": "string",                          // para filtrar por categoria (opcional)
    "onlyActiveProcesses": true,                    // apenas retorna processos ativos ou inativos (opcional)
    "serviceEventStartDate": "2021-06-16T20:35:00Z" // data a partir de qual deve buscar eventos de serviços externos (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getProcessesList" --header "Authorization: Bearer {access_token}" --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' }"

Responses:

  • 200 OK
    {
        "processes": [
            {
                "processId": 0,                             // identificador do processo
                "currentVersion": 0,                        // versão atual do processo
                "publishedVersion": 0,                      // versão publicada do processo
                "processName": "string",                    // nome do processo
                "processRawName": "string",                 // nome do processo assim como se encontra no banco de dados
                "changed": true,                            // se o processo está modificado
                "fileName": "string",                       // nome do arquivo do processo
                "status": "Saved",                          // se o processo esta publicado ou apenas salvo. Pode ser Saved ou Published
                "description": "string",                    // descrição do processo
                "creationDate": "2021-06-19T18:13:16.297Z", // data de criação do processo
                "active": true,                             // se o processo está ativo
                "embedded": true,                           // se o processo é embarcado
                "simple": true,                             // se o processo é simples
                "tag": "string",                            // tag agrupador de processos
                "accessLevel": "EDIT_AND_START",            // indica o nível de acesso do usuário ao processo. Pode ser EDIT_AND_START, START, EDIT ou NONE
                "icon": "string",                           // ícone do processo
                "serviceEventQtyByType": [                  // listagem dos tipos e quantidade de eventos de serviço externo
                    {
                        "type": "IN_PROGRESS",              // tipo do evento
                        "quantity": 0                       // quantidade de eventos
                    }
                ]
            }
        ]
    }

    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"
    }

Este artigo foi útil para você?