Pular para o conteúdo

Eventos - Operadores

Descrição

Este endpoint permite ao integrador consultar os logs de atividades dos Operadores.

HTTP request

GET /reports/v2/operators

Request Headers

ChaveValor
AuthorizationBearer <ACCESS_TOKEN>
Acceptapplication/json

Query Parameters

ChaveTipoDescrição
msgstringMensagem ou conteúdo do evento utilizado como filtro da pesquisa.
operadorstringNome do Operador para pesquisa.
startintegerData e hora inicial da consulta, em Unix Timestamp (milissegundos).
endintegerData e hora final da consulta, em Unix Timestamp (milissegundos).
limitintegerNúmero máximo de resultados a serem retornados por página.
indexintegerÍndice utilizado para controle da paginação dos resultados.

Exemplo de Requisição

GET /reports/v2/operators?msg=&operador=&start=1786503600000&end=1786589999000&limit=100&index=0
Host: api.exemplo.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/json

Estrutura da Resposta

A API retorna um objeto JSON contendo os registros encontrados e, quando aplicável, a referência para a próxima página de resultados.

Objeto principal

ChaveTipoDescrição
dataarrayLista de registros retornados pela consulta.
nextstringURI para consulta da próxima página de resultados. Quando não houver próxima página, o valor poderá ser vazio.

Estrutura dos registros em data

ChaveTipoDescrição
OPERADORstringNome do Operador associado ao evento.
MODULOstringMódulo do STCP responsável pelo registro do evento.
CODIGOMENSAGEMstringCódigo identificador do evento.
MENSAGEMstringDetalhes do evento ou da operação executada.
DATAHORAstringData e hora da ocorrência do evento.

Exemplo de Resposta (Sucesso com Dados)

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

Exemplo de Resposta (Sem Dados)

{
  "data": null,
  "next": ""
}

Paginação

Quando existirem mais resultados disponíveis, o campo next retornará a URI que deverá ser utilizada para consultar a próxima página.

Exemplo:

/reports/v2/operators?end=1786579199000&index=47165&limit=100&msg=&operador=&start=1785553200000

Códigos de Status da Resposta

CódigoDescrição
200Sucesso – A requisição foi processada com êxito.
400Requisição inválida – Parâmetros incorretos ou formato de requisição inválido.
401Não autorizado – Token de autenticação inválido ou ausente.
500Erro interno do servidor – Ocorreu um erro inesperado no servidor.