---
title: "Audit"
source: /fr/gcxone/api/audit
locale: fr
updated: 2026-09-04
---
Opérations sur les ressources d’audit. 5 points de terminaison, chacun relatif à `https://api.nxgen.cloud/api/v1` et authentifié comme décrit sous [Authentication](/gcxone/api/authentication).

## POST /log/audit

Ajouter un nouvel enregistrement d’audit. En général, toutes les API CRUD capturent les actions de l’utilisateur dans le journal d’audit lorsque l’API est exécutée avec succès. Cette API AUDIT POST est utilisée pour enregistrer les interactions utilisateur qui ne peuvent pas être enregistrées via d’autres appels d’API.

### Corps de la demande

Filtrage et tri de l’audit

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

### Réponses

| Statut | Description | Corps |
| --- | --- | --- |
| 200 | Succès | objet |
| 204 | Pas de contenu |  |
| 400 | Entrée invalide |  |
| 401 | Non autorisé |  |
| 403 | Interdit |  |

Exemple `200` réponse :

```json
{
  "data": "Audit added successfully"
}
```

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

Obtenir la liste des Événements associés à un workflow.

### Paramètres

| Nom | Dans | Type | Obligatoire | Description |
| --- | --- | --- | --- | --- |
| id | path | string | oui | Travail flow id |

### Réponses

| Statut | Description | Corps |
| --- | --- | --- |
| 200 | Succès | object |
| 400 | Entrée invalide |  |
| 403 | Interdit |  |

Exemple`200` réponse:

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

Exemple`400` réponse:

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

## POST /log/audit/filter

Récupérer les journaux d’audit avec filtrage, tri et pagination. Permet la recherche par niveau hiérarchique. Peut être filtré en utilisant la hiérarchie spécifiée ou utilise la hiérarchie de l’utilisateur connecté. Cette option permet d’obtenir des champs d’entité supplémentaires dans la réponse. Fournit également les métadonnées de configuration concernant l’entité.

### Corps de la Demande

Filtrage et tri d’audit

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

### Réponses

| Statut | Description | Corps |
| --- | --- | --- |
| 200 | Succès | object |
| 204 | Pas de contenu |  |
| 400 | Entrée invalide |  |
| 401 | Non autorisé |  |
| 403 | Interdit |  |

Exemple`200` réponse:

```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 fichier PDF contenant les détails du flux de travail.

### Paramètres

| Nom | Dans | Type | Obligatoire | Description |
| --- | --- | --- | --- | --- |
| id | path | string | oui | Identifiant du flux de travail |
| tzone | path | string | non | Fuseau horaire de l'application cliente. |

### Réponses

| Statut | Description | Corps |
| --- | --- | --- |
| 200 | Succès |  |
| 400 | Entrée invalide |  |
| 403 | Interdit |  |

## POST /log/eventlog

Obtenir la liste des journaux d'événements pour une entité particulière.

### Corps de la demande

Obtenir les journaux d'événements.

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

### Réponses

| Statut | Description | Corps |
| --- | --- | --- |
| 200 | Succès | objet |
| 400 | Entrée invalide |  |
| 403 | Interdit |  |
| 404 | Pas trouvé |  |

Exemple `200` réponse :

```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
    }
  }
}
```

Exemple `400` réponse :

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

Exemple `404` réponse :

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