Fornece dados agregados e indicadores gerenciais sobre as Ordens de Serviço (OS), utilizados em dashboards, gráficos e visualizações do tipo Kanban para acompanhamento operacional por administradores de frota e backoffice.

Funcionalidades Principais

Abaixo estão os atalhos para as operações mais utilizadas neste módulo:

Gráfico de valores totais por mês
Gráfico de valores médios por mês
Exibição Kanban para administradores de frota
OS executadas por mês
Contagem de OS por status
OS por mês
OS por dia

Gráfico de valores totais por mês

Retorna os valores totais (financeiros) das OS agregados por mês, para uso em gráficos.

Endpoint: /api/service-requests/dashboard/total-values

Método: GET

Parâmetros:

filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro (ex.: período, cliente, oficina).

Response body (payload de exemplo vazio na documentação de origem — recomenda-se detalhar a estrutura real dos dados agregados):

{}

Gráfico de valores médios por mês

Retorna o valor médio das OS agregado por mês.

Endpoint: /api/service-requests/dashboard/medium-values

Método: GET

Parâmetros:

filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro.

Response body (payload de exemplo vazio na documentação de origem):

{}

Exibição Kanban para administradores de frota

Retorna uma listagem paginada de OS organizadas em formato Kanban, para uso por administradores de frota.

Endpoint: /api/service-requests/dashboard/fleet-adm-kanban

Método: GET

Parâmetros:

key (query, obrigatório, string) — Chave/coluna do Kanban a ser consultada (ex.: status da etapa).
filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro.
page (query, obrigatório, tipo não especificado) — Paginação.

Response body:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "licensePlate": "string",
      "model": "string",
      "date": "2024-01-01T00:00:00Z",
      "period": "string",
      "requestId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

OS executadas por mês

Retorna a quantidade/série de OS executadas, agregada por mês.

Endpoint: /api/service-requests/dashboard/executed-by-month

Método: GET

Parâmetros:

filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro.

Response body (payload de exemplo vazio na documentação de origem):

{}

Contagem de OS por status

Retorna a quantidade de OS agrupada por status atual.

Endpoint: /api/service-requests/dashboard/by-status

Método: GET

Parâmetros:

Não especificados na documentação de origem.

Response body (payload de exemplo vazio na documentação de origem):

{}

OS por mês

Retorna a quantidade/série de OS executadas, agregada por mês.

Endpoint: /api/service-requests/dashboard/executed-by-month

Método: GET

Parâmetros:

filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro.

Response body (payload de exemplo vazio na documentação de origem):

{}

OS por dia

Retorna a quantidade de OS agregada por dia (detalhamento diário dentro do mês).

Endpoint: /api/service-requests/dashboard/by-month-by-day

Método: GET

Parâmetros:

filterDTO (query, obrigatório, tipo não especificado) — Objeto/parâmetros de filtro.

Response body (payload de exemplo vazio na documentação de origem):

{}