Plugin URA - Autoatendimento (C)

Relatório: Plugin URA - Autoatendimento (C)

Descrição: Este relatório fornece informações gerais sobre o Plugin URA - Autoatendimento (C). Ele inclui dados sobre autenticação, desbloqueio de solicitações, envio de notificações, encaminhamentos e outras atividades relacionadas.

Informações Gerais

Módulo: service/v1

Versão: 1.0

Autor: I9corp

E-mail de Suporte: support@i9corp.com.br

Endpoint para Gerar o Relatório

Para gerar este relatório, você pode enviar uma solicitação POST para o endpoint abaixo. Certifique-se de incluir os filtros de data de início e data de fim como parâmetros.

Endpoint:

{{HOST}}/service/v1/report/addon-rtp-0005

Parâmetros da Solicitação

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        },
        {
            "field": "dateEnd",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        }
    ],
    "format": "json"
}

Resposta do Relatório

O relatório será retornado no formato JSON, contendo as seguintes informações:

{
    "page": 1,
    "iTotalRecords": 1,
    "iTotalDisplayRecords": 1,
    "aaData": {
        "general": [
            {
                "authenticated": 4,
                "found": 0,
                "request_unlock": 0,
                "accepted_unlock": 0,
                "deny_unlock": 0,
                "send_notification": 0,
                "forward": 0,
                "date": "YYYY-MM-DD"
            }
        ]
    }
}

Propriedades da Resposta

As propriedades a seguir são retornadas no formato JSON:

Propriedade	Descrição	Tipo
`authenticated`	Número de autenticações	Integer
`found`	Número de registros encontrados	Integer
`request_unlock`	Número de solicitações de desbloqueio	Integer
`accepted_unlock`	Número de desbloqueios aceitos	Integer
`deny_unlock`	Número de desbloqueios negados	Integer
`send_notification`	Número de notificações enviadas	Integer
`forward`	Número de encaminhamentos	Integer
`date`	Data do registro	String

Lembre-se de substituir {{HOST}} pela URL real do host do seu serviço. Além disso, insira as datas de início e fim corretas como parâmetros.

Requisição

Parâmetros Header

PreAuthorization

string

requerido

Exemplo:

Bearer {{access_token}}

Parâmetros Bodyapplication/json

filters

array [object {2}]

requerido

field

string

requerido

selectedValue

string

requerido

format

string

requerido

Exemplo

{
  "filters": [
    {
      "field": "dateStart",
      "selectedValue": "2023-01-01 00:00:00"
    },
    {
      "field": "dateEnd",
      "selectedValue": "2024-02-03 23:59:59"
    }
  ],
  "format": "json"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Plugin URA - Autoatendimento (C)

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

object

requerido

general

array [object {8}]

requerido

Exemplo

{
  "page": 1,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": {
    "general": [
      {
        "authenticated": 4,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-01-04"
      },
      {
        "authenticated": 1,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-01-05"
      },
      {
        "authenticated": 3,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-02-13"
      },
      {
        "authenticated": 1,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-04-08"
      },
      {
        "authenticated": 3,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-04-28"
      },
      {
        "authenticated": 2,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-05-03"
      },
      {
        "authenticated": 1,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-05-06"
      },
      {
        "authenticated": 3,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-05-08"
      },
      {
        "authenticated": 13,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-07-06"
      },
      {
        "authenticated": 4,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-07-31"
      },
      {
        "authenticated": 2,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-08-17"
      },
      {
        "authenticated": 2,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-08-18"
      },
      {
        "authenticated": 1,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-08-25"
      },
      {
        "authenticated": 2,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-09-04"
      },
      {
        "authenticated": 1,
        "found": 1,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 1,
        "date": "2023-10-30"
      },
      {
        "authenticated": 1,
        "found": 0,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 0,
        "forward": 0,
        "date": "2023-10-31"
      },
      {
        "authenticated": 1,
        "found": 1,
        "request_unlock": 0,
        "accepted_unlock": 0,
        "deny_unlock": 0,
        "send_notification": 1,
        "forward": 1,
        "date": "2023-11-24"
      }
    ]
  }
}

Plugin URA - Autoatendimento (C)

Relatório: Plugin URA - Autoatendimento (C)#

Informações Gerais#

Endpoint para Gerar o Relatório#

Parâmetros da Solicitação#

Resposta do Relatório#

Propriedades da Resposta#

Requisição

Exemplos de Requisição

Respostas

Relatório: Plugin URA - Autoatendimento (C)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta