EUCA

Derzeit haben wir folgende Typen von Clean Up Tasks: formdata, notifications, requestreports, tos (für Terms Of Use), wizard, transactionsvoid und transactions. Mithilfe der folgenden Endpoints können Clean Up Prozesse durchgeführt werden:

1. POST /cleanup

Alle Arten von Aufgaben werden asynchron bereinigt. Der Benutzer erhält als Antwort die Bestätigung, dass die Aufgaben im Hintergrund ausgeführt werden. Dies gilt auch für alle anderen Endpunkte, die spezifische Aufgabenbereinigungen durchführen.

1.2. POST /cleanup/{type}

Alle Tasks mit dem Typen werden aufgeräumt.

1.3. POST /cleanup/{type} (Mit Sortierkriterium)

Alle Tasks mit dem Typen und den zutreffenden Kriterium werden gelöscht. Achtung: Endpoints haben verschiedene Sortierkriterien.

1.3.1 POST /cleanup/notifications/{olderThanDays}

Notifications entfernen, die älter als eine bestimmte Anzahl von Tagen sind.

1.3.2 POST /cleanup/transactionsvoid/{minutes}

Transaktionen leeren und löschen, die älter als spezifischen Minuten sind.

1.3.3 POST /cleanup/transactions/{days}

Transaktionen entfernen, die älter als eine bestimmte Anzahl an Tagen sind.

1.3.4 POST /cleanup/requestedreports/{Year-Month-Day}

Reports entfernen, die früher als einem bestimmten Datum sind. Beachten Sie auf den Format des Parameters: year-month-day, z.b 2023-04-01 (1. April 2023)

2. GET /cleanup/status

Man erhält eine Übersicht über die aktuellen Bereinigungsaufgaben. Wenn ein bestimmter Bereinigungsvorgang noch nie durchgeführt wurde, erhält der Benutzer lediglich die Informationen zum Schlüssel und Schema des Vorgangs. Folgende Status kann ein Bereinigungsvorgang besitzen: finished, running, failed. Die Tasks, die noch nie ausgeführt wurden oder zurückgesetzt werden, werden nicht im Response vorkommen.



[

   {

      "key":"wizard",

      "status":"FINISHED",

      "errorMessage":"",

      "startedAt":"2024-04-23T08:00:56.696Z",

      "finishedAt":"2024-04-23T08:00:58.287Z",

      "schemaName":"acta_nova_cleanup_task"

   },

   "...... Weitere Tasks"

]

2.1 GET /cleanup/status/{status}

Liefert eine Liste von Bereinigungsvorgänge, die dem Status entsprechen.

3. DELETE /cleanup/reset

Setzt alle Bereinigungsvorgänge zurück. Wenn man jetzt get status aufruft, sieht man keine Tasks mehr.

3.1 DELETE /cleanup/reset/{type}

Setzt einen bestimmten Bereinigungsvorgang zurück.

Sicherung der Endpoints

Es stehen zwei Optionen zur Verfügung, um auf die Endpunkte zuzugreifen:

Der Benutzer meldet sich als Administrator an und sendet anschließend den generierten Token im Request mit.
Falls der Benutzer kein Administrator ist, aber dennoch Bereinigungsaufgaben durchführen möchte, muss die Umgebungsvariable MESH_PLUGIN_ACTA_NOVA_CLEANUP_SECRET in Mesh konfiguriert sein. Sobald diese konfiguriert ist, kann der Benutzer das entsprechende Geheimnis als Abfrageparameter am Ende des ursprünglichen Endpunkts anhängen (z. B. /cleanup/?secret=secrete123), um auf den entsprechenden Endpunkt zuzugreifen.

Clean Up Handler Endpoints