APIs - Tutoriais

FindProcess

124 views 17/06/2021 21/06/2021 alex-serodio 0

FindProcess

Busca um processo do Workflow através do identificador do processo.

Payload de entrada:

{
   "id": 1,      // identificador numérico do processo
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/findProcess" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'id': 1 }"

Responses:

  • 200 OK
    {
        "process": {
            "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
                }
            ]
        }
    }
  • 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ê?