Informes

Formato común

Todos los informes usan GET, exigen Authorization: Bearer <access_token> y Accept: application/json, y responden con el mismo formato:

Campo	Tipo	Descripción
`data`	array o `null`	Registros encontrados. `null` cuando no hay registros.
`next`	string	URI de la página siguiente. Vacía cuando no hay página siguiente.

Todos exigen el permiso stcpadminsvc.report_evt_sys ≥ 1 en el scope del operador.

Parámetros comunes

Parámetro	Tipo	Descripción
`start`	integer	Obligatorio. Inicio del período (Unix timestamp en milisegundos).
`end`	integer	Obligatorio. Fin del período (Unix timestamp en milisegundos).
`msg`	string	Fragmento del texto del mensaje.
`code`	string	Código del mensaje, como `MSG0065`.
`limit`	integer	Registros por página. Predeterminado `100`; máximo `15000`.
`index`	integer	Índice de paginación, informado en la URI de `next`.

Respuestas

HTTP	Significado
`200`	Consulta concluida.
`400`	Header `Authorization` ausente o mal formado.
`401`	Token no válido o expirado.
`403`	Operador sin el permiso de informes, o `start`/`end` ausentes o no enteros.
`500`	Error interno.

Nota

La API responde 403, y no 400, cuando start o end no se informan o no son enteros. El mensaje de error indica el parámetro, por ejemplo start should be an integer.

El contrato completo, con todos los parámetros y ejemplos, está en la Especificación OpenAPI.

`GET` `/reports/v2/system`

Eventos de sistema de los módulos de la plataforma.

Parámetro	Tipo	Descripción
`instance`	string	Instancia.
Comunes	—	`start`, `end`, `msg`, `code`, `limit` e `index`. Vea Formato común.

Campos de data[]:

Campo	Tipo	Descripción
`DATAHORA`	string	Fecha y hora de la ocurrencia.
`INSTANCE`	string	Instancia.
`USUARIO`	string	Módulo que registró el evento.
`CODIGOMENSAGEM`	string	Código del evento (p. ej., `MSG0910`).
`MENSAGEM`	string	Mensaje del 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 de las conexiones de los usuarios.

Parámetro	Tipo	Descripción
`instance`	string	Instancia.
`user`	string, repetible	Usuario. Repita el parámetro para más de un usuario.
Comunes	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]: iguales a los de /reports/v2/system, con USUARIO conteniendo el usuario.

{
  "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`

Todos los mensajes registrados para la instancia.

Parámetro	Tipo	Descripción
`instance`	string	Instancia.
`user`	string, repetible	Usuario.
Comunes	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]: iguales a los de /reports/v2/system.

`GET` `/reports/v2/operators`

Actividades de los operadores, incluidas las llamadas realizadas mediante la API.

Parámetro	Tipo	Descripción
`operador`	string	Operador.
Comunes	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]:

Campo	Tipo	Descripción
`OPERADOR`	string	Operador asociado al evento.
`MODULO`	string	Módulo que registró el evento.
`CODIGOMENSAGEM`	string	Código del evento.
`MENSAGEM`	string	Detalles de la operación (servicio, operador, estado, método y ruta).
`DATAHORA`	string	Fecha y hora de la ocurrencia.

{
  "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`

Historial de transferencias.

Parámetro	Tipo	Descripción
`instance`	string	Instancia.
`user`	string, repetible	Usuario. Cada usuario corresponde a un único buzón.
`tags`	string, repetible	Tag del tipo de archivo.
`events`	integer, repetible	`5` = transmisión; `7` = recepción. Repita el parámetro para ambos.
`results`	integer	`0` = solo exitosas; `-1` = solo con error. Omítalo para ambos.
`filename`	string	Nombre del archivo.
Comunes	—	`start`, `end`, `msg`, `code`, `limit` e `index`.

Campos de data[]:

Campo	Tipo	Descripción
`DATAHORA`	string	Fecha y hora de la ocurrencia.
`INSTANCE`	string	Instancia.
`USUARIO`	string	Usuario (y su buzón) o módulo.
`CONEXAO`	string	Detalles de la conexión o del enrutamiento (Riversoft STCP Gemini Rename).
`DATAARQUIVO`	string	Fecha del archivo.
`HORAARQUIVO`	string	Hora del archivo.
`EVENTO`	integer	`5` = transmisión; `7` = recepción.
`MAXTAMREG`	integer	Tamaño del registro fijo o variable (LRECL), en bytes.
`NUMREG`	integer	Cantidad de registros.
`MENSAGEM`	string	Mensaje del sistema.
`NOMEARQUIVO`	string	Nombre del archivo.
`TAGS`	string	Tags del tipo de archivo.
`PROCID`	integer	Código interno del proceso.
`REDE`	string	Red o función STCP utilizada.
`RESULTADO`	integer	Código de retorno: `0` = éxito; otro valor = código del error.
`TAMARQUIVO`	integer	Tamaño del archivo.
`THREADID`	integer	Thread que ejecutó el proceso.
`TIPOREC`	string	Formato del registro (RECFM).
`DIAS`	integer	Días desde la ocurrencia.

{
  "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"
}

Auditoría

Los informes de auditoría devuelven todos los registros del período, sin paginación (next).

Endpoint	Contenido
`GET /reports/v2/audit/transfers`	Transferencias: transmisiones (`EVENTO` = `5`) y recepciones (`7`).
`GET /reports/v2/audit/sessions`	Sesiones: conexiones de entrada (`EVENTO` = `1`) y de salida (`3`).
`GET /reports/v2/audit/statistics`	Totales de transferencias agrupados por período.

Parámetro	Tipo	Descripción
`start`, `end`	integer	Obligatorios. Período (Unix timestamp en milisegundos).
`instance`	string	Instancia. Obligatorio en `statistics`.
`user`	string, repetible	Usuario.
`tags`	string, repetible	Tag del tipo de archivo.
`filename`	string	Nombre del archivo.
`direction`	string	`transfers` y `sessions`: `in` = entrada; `out` = salida. Omita para las dos.
`status`	string	`transfers` y `sessions`: `error` = con error; `all` = todos. Omita para solo con éxito.
`statistics`	string	`statistics`: `year`, `month`, `week`, `dayofweek`, `day` u `hour`. Omita para el total del 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"

Autenticación Recursos de gestión

Informes

Formato común

GET /reports/v2/system

GET /reports/v2/users

GET /reports/v2/instance

GET /reports/v2/operators

GET /reports/v2/transfers

Auditoría

`GET` `/reports/v2/system`

`GET` `/reports/v2/users`

`GET` `/reports/v2/instance`

`GET` `/reports/v2/operators`

`GET` `/reports/v2/transfers`