Relatórios

Formato comum

Todos os relatórios usam GET, exigem Authorization: Bearer <access_token> e Accept: application/json e respondem no mesmo formato:

Campo	Tipo	Descrição
`data`	array ou `null`	Registros encontrados. `null` quando não há registros.
`next`	string	URI da próxima página. Vazia quando não há próxima página.

Todos exigem a permissão stcpadminsvc.report_evt_sys ≥ 1 no scope do operador.

Parâmetros comuns

Parâmetro	Tipo	Descrição
`start`	integer	Obrigatório. Início do período (Unix timestamp em milissegundos).
`end`	integer	Obrigatório. Fim do período (Unix timestamp em milissegundos).
`msg`	string	Trecho do texto da mensagem.
`code`	string	Código da mensagem, como `MSG0065`.
`limit`	integer	Registros por página. Padrão `100`; máximo `15000`.
`index`	integer	Índice de paginação, informado na URI de `next`.

Respostas

HTTP	Significado
`200`	Consulta concluída.
`400`	Header `Authorization` ausente ou malformado.
`401`	Token inválido ou expirado.
`403`	Operador sem a permissão de relatórios, ou `start`/`end` ausentes ou não inteiros.
`500`	Erro interno.

Nota

A API responde 403, e não 400, quando start ou end não são informados ou não são números inteiros. A mensagem de erro indica o parâmetro, por exemplo start should be an integer.

O contrato completo, com todos os parâmetros e exemplos, está na Especificação OpenAPI.

`GET` `/reports/v2/system`

Eventos de sistema dos módulos da plataforma.

Parâmetro	Tipo	Descrição
`instance`	string	Instância.
Comuns	—	`start`, `end`, `msg`, `code`, `limit` e `index`. Veja Formato comum.

Campos de data[]:

Campo	Tipo	Descrição
`DATAHORA`	string	Data e hora da ocorrência.
`INSTANCE`	string	Instância.
`USUARIO`	string	Módulo que registrou o evento.
`CODIGOMENSAGEM`	string	Código do evento (ex.: `MSG0910`).
`MENSAGEM`	string	Mensagem do evento.

{
  "data": [
    {
      "DATAHORA": "2025-12-20T19:54:17-03:00",
      "INSTANCE": "STCPGEMINI",
      "USUARIO": "<STCPDirectLink>",
      "CODIGOMENSAGEM": "MSG0910",
      "MENSAGEM": "code=MSG0910 module=<STCPDirectLink> msg=..."
    }
  ],
  "next": "/reports/v2/system?end=1786579199000&index=44497&instance=STCPGEMINI&limit=&msg=&start=1785553200000"
}

`GET` `/reports/v2/users`

Eventos das conexões dos usuários.

Parâmetro	Tipo	Descrição
`instance`	string	Instância.
`user`	string, repetível	Usuário. Repita o parâmetro para mais de um usuário.
Comuns	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]: iguais aos de /reports/v2/system, com USUARIO contendo o usuário.

{
  "data": [
    {
      "DATAHORA": "2025-12-20T20:03:05-03:00",
      "INSTANCE": "STCPGEMINI",
      "USUARIO": "01USER",
      "CODIGOMENSAGEM": "MSG0065",
      "MENSAGEM": "code=MSG0065 direction=OUT msg=\"fim de conexao de saída...\""
    }
  ],
  "next": "/reports/v2/users?end=1786579199000&index=45011&instance=STCPGEMINI&limit=1&start=1785553200000"
}

`GET` `/reports/v2/instance`

Todas as mensagens registradas para a instância.

Parâmetro	Tipo	Descrição
`instance`	string	Instância.
`user`	string, repetível	Usuário.
Comuns	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]: iguais aos de /reports/v2/system.

`GET` `/reports/v2/operators`

Atividades dos operadores, inclusive as chamadas feitas pela API.

Parâmetro	Tipo	Descrição
`operador`	string	Operador.
Comuns	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]:

Campo	Tipo	Descrição
`OPERADOR`	string	Operador associado ao evento.
`MODULO`	string	Módulo que registrou o evento.
`CODIGOMENSAGEM`	string	Código do evento.
`MENSAGEM`	string	Detalhes da operação (serviço, operador, status, método e caminho).
`DATAHORA`	string	Data e hora da ocorrência.

{
  "data": [
    {
      "OPERADOR": "stcpadmin",
      "MODULO": "<STCPRestAPI>",
      "CODIGOMENSAGEM": "MSG3100",
      "MENSAGEM": "service=riversoft-rest-api operator=stcpadmin status=200 method=GET path=/reports/v2/operators?...",
      "DATAHORA": "2026-08-12T05:16:02-03:00"
    }
  ],
  "next": "/reports/v2/operators?end=1786589999000&index=47043&limit=100&msg=&operador=&start=1786503600000"
}

`GET` `/reports/v2/transfers`

Histórico de transferências.

Parâmetro	Tipo	Descrição
`instance`	string	Instância.
`user`	string, repetível	Usuário. Cada usuário corresponde a uma única caixa postal.
`tags`	string, repetível	Tag do tipo de arquivo.
`events`	integer, repetível	`5` = transmissão; `7` = recepção. Repita o parâmetro para os dois.
`results`	integer	`0` = somente com sucesso; `-1` = somente com erro. Omita para os dois.
`filename`	string	Nome do arquivo.
Comuns	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]:

Campo	Tipo	Descrição
`DATAHORA`	string	Data e hora da ocorrência.
`INSTANCE`	string	Instância.
`USUARIO`	string	Usuário (e sua caixa postal) ou módulo.
`CONEXAO`	string	Detalhes da conexão ou do roteamento (Riversoft STCP Gemini Rename).
`DATAARQUIVO`	string	Data do arquivo.
`HORAARQUIVO`	string	Hora do arquivo.
`EVENTO`	integer	`5` = transmissão; `7` = recepção.
`MAXTAMREG`	integer	Tamanho do registro fixo ou variável (LRECL), em bytes.
`NUMREG`	integer	Quantidade de registros.
`MENSAGEM`	string	Mensagem do sistema.
`NOMEARQUIVO`	string	Nome do arquivo.
`TAGS`	string	Tags do tipo de arquivo.
`PROCID`	integer	Código interno do processo.
`REDE`	string	Rede ou função STCP utilizada.
`RESULTADO`	integer	Código de retorno: `0` = sucesso; outro valor = código do erro.
`TAMARQUIVO`	integer	Tamanho do arquivo.
`THREADID`	integer	Thread que executou o processo.
`TIPOREC`	string	Formato do registro (RECFM).
`DIAS`	integer	Dias desde a ocorrência.

{
  "data": [
    {
      "DATAHORA": "2025-12-19T15:18:53Z",
      "INSTANCE": "STCPGEMINI",
      "USUARIO": "01USER",
      "CONEXAO": "[TCP-IN-oTLS] R:203.0.113.45:10400 L:198.51.100.10:6619",
      "DATAARQUIVO": "20251219",
      "EVENTO": 5,
      "HORAARQUIVO": "1513573419",
      "MAXTAMREG": 0,
      "NUMREG": 0,
      "MENSAGEM": "Fim de transmissao",
      "NOMEARQUIVO": "/stcp/data/STCPGEMINI/01USER/SAIDA/file.txt",
      "TAGS": "",
      "PROCID": 45325,
      "REDE": "IN",
      "RESULTADO": 0,
      "TAMARQUIVO": 7972,
      "THREADID": 3699586,
      "TIPOREC": "U",
      "DIAS": 0
    }
  ],
  "next": "/reports/v2/transfers?end=1786579199000&events=&index=4441011&limit=2&start=1704078000000"
}

Auditoria

Os relatórios de auditoria retornam todos os registros do período, sem paginação (next).

Endpoint	Conteúdo
`GET /reports/v2/audit/transfers`	Transferências: transmissões (`EVENTO` = `5`) e recepções (`7`).
`GET /reports/v2/audit/sessions`	Sessões: conexões de entrada (`EVENTO` = `1`) e de saída (`3`).
`GET /reports/v2/audit/statistics`	Totais de transferências agrupados por período.

Parâmetro	Tipo	Descrição
`start`, `end`	integer	Obrigatórios. Período (Unix timestamp em milissegundos).
`instance`	string	Instância. Obrigatório em `statistics`.
`user`	string, repetível	Usuário.
`tags`	string, repetível	Tag do tipo de arquivo.
`filename`	string	Nome do arquivo.
`direction`	string	`transfers` e `sessions`: `in` = entrada; `out` = saída. Omita para as duas.
`status`	string	`transfers` e `sessions`: `error` = com erro; `all` = todos. Omita para somente com sucesso.
`statistics`	string	`statistics`: `year`, `month`, `week`, `dayofweek`, `day` ou `hour`. Omita para o total do período.

curl -s -G "$API_BASE/reports/v2/audit/transfers" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data-urlencode "instance=STCPGEMINI" \
  --data-urlencode "direction=in" \
  --data-urlencode "status=all" \
  --data-urlencode "start=1785553200000" \
  --data-urlencode "end=1786579199000"

Autenticação Recursos de gestão

Relatórios

Formato comum

GET /reports/v2/system

GET /reports/v2/users

GET /reports/v2/instance

GET /reports/v2/operators

GET /reports/v2/transfers

Auditoria

`GET` `/reports/v2/system`

`GET` `/reports/v2/users`

`GET` `/reports/v2/instance`

`GET` `/reports/v2/operators`

`GET` `/reports/v2/transfers`