Skip to main content
Skip table of contents

Erzeugen eines Reminders mit der REST-API

In diesem Thema erfahren Sie, wie Sie einen Reminder mithilfe des Webservice-Endpunkts erzeugen können. Die benötigten Reminderdaten werden als JSON-Objekt mittels der POST-Methode an den Webservice-Endpunkt übermittelt.

Zum Authentifizieren am Webservice-Endpunkt wird ein API-Schlüssel benötigt. Den API-Schlüssel müssen Sie vor dem Bereitstellen (Deployment) und Release der App in edoc automate anpassen.

So passen Sie den API-Schlüssel in edoc automate an

  1. Gehen Sie in edoc automate in der Navigationsleiste auf App-Details und öffnen Sie im Arbeitsbereich die App-Variablen.

  2. Ersetzen Sie den Wert der Variablen rest_api.reminder_create.api_key durch einen neuen API-Schlüssel (API key).

Mit der folgenden URL rufen Sie den Webservice-Endpunkt zum Erstellen eines Reminders auf: https://<app-server>/apps/ws/edoc-contract/createReminder

Ersetzen Sie den Platzhalter <app-server> durch den Namen des Servers, auf dem edoc automate ausgeführt wird.

Wissenswertes zu Datumsfeldern

Ganz gleich, welche Reminderart Sie erzeugen möchten, Sie müssen Datumsangaben immer im ISO-Format JJJJ-MM-TT (z.B.: 2023-11-24) angeben.

Standardparameter des JSON-Objekts für verschiedene Reminderarten

Das JSON-Objekt sieht für die verschiedenen Reminderarten unterschiedlich aus. Es gibt eine Reihe von Informationen, die Sie für jedes JSON-Objekt standardmäßig angeben müssen.

Sie müssen folgende Daten immer übertragen, unabhängig von der Reminderart:

  • ecm_id: Geben Sie die eindeutige ID des Vertrags im ECM-System an.

  • reminder_type: Geben Sie den numerischen Wert für die Reminderart an:

    • 1 ist der Wert für eine Aufgabe.

    • 2 ist der Wert für eine Kündigung.

    • 3 ist der Wert für einfache Verlängerung.

    • 5 ist der Wert für eine Garantie.

    • 6 ist der Wert für eine rollierende Verlängerung.

  • reminder_note: Geben Sie bei Bedarf eine Bemerkung zum Reminder ein.

  • reminder_date: Geben Sie das Datum (JJJJ-MM-TT) für den Reminder an.

  • reminder_recipients: Geben Sie die technischen Namen der Empfänger durch Komma getrennt an.

  • creator: Geben Sie den technischen Name des Erstellers des Reminders an.

  • switch_notification_done_activate: Geben Sie den numerischen Wert zum Aktivieren der E-Mail-Benachrichtigung bei Erledigung einer Aufgabe ein:

    • 1 bedeutet, dass die Benachrichtigung aktiviert ist.

    • 2 bedeutet, dass die Benachrichtigung deaktiviert ist.

  • recipients_notification_done: Geben Sie die technischen Namen der Empfänger durch Komma getrennt an, die beim Erledigen einer Aufgabe eine E-Mail-Benachrichtigung erhalten sollen.

Parameter für eine einfache Aufgabe (Reminderart 1)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine einfache Aufgabe angeben:

  • task_periodical_active: Geben Sie den numerischen Wert 0 zum Erstellen einer einfachen Aufgabe.

Beispiel für ein JSON-Objekt für eine einfache Aufgabe:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "1",
	"reminder_note": "Create simple task",
	"reminder_date": "2023-11-24",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"task_periodical_active": "0"
}

Parameter für eine wiederkehrende Aufgabe (Reminderart 1)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine wiederkehrende Aufgabe angeben:

  • task_periodical_active: Geben Sie den numerischen Wert 1 zum Erstellen einer wiederkehrenden Aufgabe an.

  • task_unit: Geben Sie einen numerische Wert für die Einheit der Wiederholung an. Der Parameter entspricht dem Eingabefeld Einheit auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • task_count: Geben Sie den numerischen Wert für den zeitlicher Abstand der Wiederholung an. Der Parameter entspricht dem Eingabefeld Zeitlicher Abstand auf der Seite Reminder.

  • task_period_count: Geben Sie die Anzahl der Wiederholungen für die wiederkehrende Aufgabe ein. Der Parameter entspricht dem Eingabefeld Anzahl der Wiederholungen auf der Seite Reminder.

  • task_period_unlimited: Geben Sie einen numerischen Wert für die unbegrenzte Laufzeit an:

    • 0 entspricht der begrenzten Laufzeit.

    • 1 entspricht der unbegrenzten Laufzeit.

  • task_start: Geben Sie das Startdatum (JJJJ-MM-TT) für die wiederkehrende Aufgabe ein. Der Parameter entspricht dem Eingabefeld Startdatum auf der Seite Reminder.

Beispiel für ein JSON-Objekt für eine wiederkehrende Aufgabe:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "1",
	"reminder_note": "Create recurring task",
	"reminder_date": "2023-11-24",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"task_periodical_active": "1",
	"task_unit": "1",
	"task_count": "5",
	"task_period_count": "4",
	"task_period_unlimited" : "1",
	"task_start": "2023-11-24"
}

Parameter für eine Kündigung (Reminderart 2)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine Kündigung angeben:

  • notice_period_count: Geben Sie die Anzahl der Einheit für der Kündigungsfrist an. Der Parameter entspricht dem Eingabefeld Kündigungsfrist auf der Seite Reminder.

  • notice_period_unit: Geben Sie den numerischen Wert für die Einheit der Kündigungsfrist an. Der Parameter entspricht dem Eingabefeld Einheit der Kündigungsfrist auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • notice_period_end: Geben Sie das Datum der Frist (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Fristdatum auf der Reminderform.

  • notice_period_rhythm: Geben Sie den numerischen Wert an, zu welchem Rhythmus die Kündigung erfolgen soll. Der Parameter entspricht dem Eingabefeld Zum Rhythmus auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht dem Vertragsende.

    • 2 entspricht dem Monatsende.

    • 3 entspricht dem Quartalsende.

    • 4 entspricht dem Jahresende.

  • notice_period_new_contract_end: Geben Sie das Kündigungsdatum (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Kündigungsdatum auf der Seite Reminder.

Beispiel für ein JSON-Objekt für eine Kündigung:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "2",
	"reminder_id": null,
	"reminder_note": "Create a termination",
	"reminder_date": "2023-12-24",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"notice_period_count": "4",
	"notice_period_unit": "2",
	"notice_period_end": "2024-01-07",
	"notice_period_rhythm": "1",
	"notice_period_new_contract_end": "2024-02-04"
}

Parameter für eine einfache Verlängerung (Reminderart 3)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine einfache Verlängerung angeben:

  • runtime_renewal_count: Geben Sie die Anzahl der Einheit einer Laufzeit an. Der Parameter entspricht dem Eingabefeld Verlängerung der Laufzeit auf der Seite Reminder.

  • runtime_renewal_unit: Geben Sie den numerischen Wert für die Einheit der Verlängerung an. Der Parameter entspricht dem Eingabefeld Einheit der Laufzeit auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • runtime_renewal_end: Geben Sie das Datum für das Ende der Verlängerung (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Ende der Verlängerung auf der Seite Reminder.

Beispiel für ein JSON-Objekt für eine einfache Verlängerung:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "3",
	"reminder_note": "Create simple renewal",
	"reminder_date": "2024-01-28",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"runtime_renewal_count": "1",
	"runtime_renewal_unit": "2",
	"runtime_renewal_end": "2024-02-11"	
}

Parameter für eine Garantie (Reminderart 5)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine Garantie angeben:

guarantee_start: Geben Sie das Datum für den Beginn der Garantiezeit (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Garantiebeginn auf der Seite Reminder.
guarantee_end: Geben Sie das Datum zum Ende der Garantiezeit (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Garantieende auf der Seite Reminder.

Beispiel für ein JSON-Objekt für eine Garantie:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "5",
	"reminder_note": "Test - Create guarantee using API",
	"reminder_date": "2023-11-24",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"guarantee_start": "2023-11-25",
	"guarantee_end": "2023-12-08"
}

Parameter für eine unbegrenzte rollierende Verlängerung (Reminderart 6)

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine unbegrenzte, rollierende Verlängerung angeben:

  • runtime_renewal_count: Geben Sie die Anzahl der Einheit für die Laufzeit an. Der Parameter entspricht dem Eingabefeld Verlängerung der Laufzeit auf der Seite Reminder.

  • runtime_renewal_unit: Geben Sie den numerischen Wert für die Einheit der Verlängerung angegeben. Der Parameter entspricht dem Eingabefeld Einheit der Laufzeit auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • runtime_renewal_end: Geben Sie das Datum für das Ende der Verlängerung (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Ende der Verlängerung auf der Seite Reminder.

  • running_runtime_renewal_unlimited: Geben Sie den Wert 1 für eine Verlängerung mit unbegrenzter Gesamtlaufzeit. Der Parameter entspricht dem Eingabefeld Unbegrenzte Gesamtlaufzeit auf der Seite Reminder.

Beispiel für ein JSON-Objekt für eine unbegrenzte Gesamtlaufzeit eines Vertrags:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "6",
	"reminder_note": "Create recurring renewal with unlimited total term",
	"reminder_date": "2024-01-26",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"runtime_renewal_count": "5",
	"runtime_renewal_unit": "1",
	"runtime_renewal_end": "2024-02-09",
	"running_runtime_renewal_unlimited": "1"
}

Parameter für eine begrenzte rollierende Verlängerung (Reminderart 6)

Eine rollierende Verlängerung mit zeitlicher Begrenzung erstellen Sie mit der Reminderart 6.

Neben den Daten, die Sie standardmäßig angeben müssen, müssen Sie zusätzlich folgende Parameter für eine begrenzte, rollierende Verlängerung angeben:

  • runtime_renewal_count: Geben Sie die Anzahl der Einheit eine Laufzeit an. Der Parameter entspricht dem Eingabefeld Verlängerung der Laufzeit auf der Seite Reminder.

  • runtime_renewal_unit: Geben Sie den numerischen Wert für die Einheit der Verlängerung an. Der Parameter entspricht dem Eingabefeld Einheit der Laufzeit auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • runtime_renewal_end: Geben Sie das Datum für das Ende der Verlängerung (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Ende der Verlängerung auf der Seite Reminder.

  • running_runtime_renewal_unlimited: Geben Sie den Wert 0 für eine Verlängerung mit begrenzter Gesamtlaufzeit. Der Parameter entspricht dem Eingabefeld. Der Parameter entspricht dem Eingabefeld Unbegrenzte Gesamtlaufzeit auf der Seite Reminder.

  • running_runtime_renewal_count: Geben Sie die Anzahl der Einheit zum Parameter Einheit der Gesamtlaufzeit an. Der Parameter entspricht dem Eingabefeld Gesamtlaufzeit - Anzahl der Einheit auf der Seite Reminder.

  • running_runtime_renewal_unit: Geben Sie den numerische Wert für die Einheit der Gesamtlaufzeit an. Der Parameter entspricht dem Eingabefeld Einheit der Gesamtlaufzeit auf der Seite Reminder. Folgende Optionen gibt es:

    • 1 entspricht der Maßeinheit “Tag”.

    • 2 entspricht der Maßeinheit “Woche”.

    • 3 entspricht der Maßeinheit “Monat”.

    • 4 entspricht der Maßeinheit “Jahr”.

  • running_runtime_renewal_end: Geben Sie das Enddatum der rollierenden Verlängerung (JJJJ-MM-TT) an. Der Parameter entspricht dem Eingabefeld Ende der Gesamtlaufzeit auf der Seite Reminder.

Beispiel für ein JSON-Objekt zeitlich begrenzte rollierende Verlängerung eines Vertrags:

JSON 
{
	"ecm_id": "A000000009",
	"reminder_type": "6",
	"reminder_note": "Create recurring renewal with fixed term",
	"reminder_date": "2024-01-26",
	"reminder_recipients": "admin,<Name>@test.de",
	"creator": "admin",
	"switch_notification_done_activate": "1",
    "recipients_notification_done": "admin,<Name>@test.de",
	"runtime_renewal_count": "5",
	"runtime_renewal_unit": "1",
	"runtime_renewal_end": "2024-02-09",
	"running_runtime_renewal_unlimited": "0",
	"running_runtime_renewal_count": "3",
	"running_runtime_renewal_unit": "2",
	"running_runtime_renewal_end": "2024-02-25"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close