APIs - Tutoriais

GetRequestHistoryTimeline

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

GetRequestHistoryTimeline

Obtém uma linha do tempo com o registro de ações e observações de uma solicitação.

Payload de entrada:

{
    "processInstanceID": 0      // identificador da instânia do processo
}

Exemplo de request:

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

Responses:

  • 200 OK
    {
        "processName": "string",                            // nome do processo
        "timeline": [                                       // representação da linha do tempo da solicitação
            {
                "processInstanceId": 0,                     // identificador da instância do proceso
                "historyType": "STARTED",                   // tipo de entrada do histórico. Pode ser STARTED, COMMENT, ATTACHMENT_ADDED, ATTACHMENT_REMOVED, CHANGE_RESPONSIBLE, CANCEL_PENDENCY, RESPONSE_PENDENCY ou FINISHED
                "historyDate": "2021-06-19T16:30:09.570Z",  // data do histórico
                "userName": "string",                       // usuário responsável
                "impersonatedUserName": "string",           // ação executada em nome do usuário
                "taskName": "string",                       // nome da tarefa
                "actionName": "string",                     // nome da ação executada
                "userIpAddress": "string",                  // endereço IP do usuário
                "comment": "string",                        // comentário realizado na etapa do processo
                "attachmentName": "string",                 // nome do anexo
                "oldResponsible": "string",                 // responsável alterior
                "newResponsible": "string",                 // novo responsável
                "cancelReason": "string"                    // razão do cancelamento
            }
        ]
    }
  • 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ê?