Auditoría

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /log/audit
Cuerpo de la solicitud
Respuestas
GET /log/audit/eventlist/workflowid/{id}
Parámetros
Respuestas
POST /log/audit/filter
Cuerpo de la solicitud
Respuestas
GET /log/audit/report/workflowid/{id}/timezone/{tzone}
Parámetros
Respuestas
POST /log/eventlog
Cuerpo de la solicitud
Respuestas

Operaciones sobre recursos de auditoría. 5 endpoints, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Authentication.

POST /log/audit

Agregar un nuevo registro de auditoría. En general, todas las API CRUD capturan las acciones del usuario en el registro de auditoría cuando la API se ejecuta correctamente. Esta API POST AUDIT se utiliza para registrar la interacción del usuario que no es posible registrar mediante otras llamadas a API.

Cuerpo de la solicitud

Filtrado y ordenación de auditoría

json

{
  "action": "string",
  "category": "string",
  "mqttPush": "boolean",
  "payload": {
    "sourceEntityLevel": "sensor | device | site | account",
    "sourceEntityId": "string"
  },
  "deltaPayload": "string",
  "source": "string",
  "subCategory": "string",
  "userAction": "string",
  "actionStatus": "string",
  "actionTime": "number",
  "workflowId": "string",
  "workflowName": "string",
  "userName": "string"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "data": "Audit added successfully"
}

GET /log/audit/eventlist/workflowid/{id}

Obtener lista de eventos asociados a un flujo de trabajo.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	string	sí	ID de flujo de trabajo

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
400	Entrada inválida
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "data": {
    "errorCode": 0,
    "errorMessage": "if errorCode above is a negative number then this errorMessage field will give more details.",
    "message": [
      "62cba820173001197cf10420",
      "62cbac84a520010f074a4403"
    ]
  }
}

Ejemplo 400 respuesta:

json

{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

POST /log/audit/filter

Obtiene los registros de auditoría con filtrado, ordenación y paginación. Permite la búsqueda por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario autenticado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

Cuerpo de la solicitud

Filtrado y ordenación de auditoría

json

{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "commercialName",
        "DisplayName": "Audit",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isRightBorder": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "action": "Search or Tree node click",
      "actionStatus": "Success",
      "category": "Video Activity Search",
      "sourceEntityName": "8428 Moll Kaarst Lackierhalle",
      "subCategory": "Search",
      "timeStamp": 1656405046000,
      "userAction": "Event search result has been fetched",
      "userEmail": "admin@tenant.de",
      "deltaPayload": "Import Report"
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}

GET /log/audit/report/workflowid/{id}/timezone/{tzone}

Un archivo PDF con los detalles del flujo de trabajo.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	string	sí	Identificador del flujo de trabajo
tzone	path	string	no	Zona horaria de la aplicación cliente.

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
403	Prohibido

POST /log/eventlog

Obtener lista de registros de eventos para una entidad concreta.

Cuerpo de la solicitud

Obtener registros de eventos.

json

{
  "entityId": "string",
  "startTime": "number",
  "endTime": "number",
  "page": "number"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
400	Entrada inválida
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "data": {
    "errorCode": 0,
    "message": {
      "eventLogs": [
        {
          "workFlowId": "8a81bc4c820160182151cd2e86160",
          "type": "WORKFLOW",
          "timestamp": 1658211586783,
          "userName": "Christian John",
          "status": "CLOSED",
          "workflowOutcome": "alarm_false",
          "message": "Verbindungsausfall V1.1",
          "workflowOutcomeName": "Falsealarm"
        }
      ],
      "nextPage": 1
    }
  }
}

Ejemplo 400 respuesta:

json

{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

Ejemplo 404 respuesta:

json

{
  "errorCode": "404",
  "errorDesc": "Not Found"
}

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.