Api

Beschreibung

Ermöglicht den Aufruf von parametrierter Funktionalität über das REST-API.

Folgende Anwendungsfälle werden unterstützt:

• Einbindung einer programmierten ApiRule oder eines parametrierten Prozesses.
• Swagger-Seite mit Dokumentation der Endpunkte.
• Synchrone oder asynchrone Verarbeitung.
• Speicherung des Payloads.
• Sicherstellen, dass eine Meldung nicht doppelt verarbeitet wird.

Die APIs werden im Raum System unter XML-Konfig als Konfigurationen vom Typ ApiDefinition parametriert.

Bausteine

Entities

• IApiInItem

• IApiOutItem

Activities

• AbortApiInItem

• AbortApiInItems

• AbortApiOutItem

• AbortApiOutItems

• ProcessApiInRequest

• ProcessApiOutRequest

• ResumeSuspendedApiInItem

• ResumeSuspendedApiInItems

• ResumeSuspendedApiOutItem

• ResumeSuspendedApiOutItems

Queries

• QueryApiInItems

• QueryApiOutItems

ValueLists

• ValueListApiDefinitions

Expression Functions

• GetApiPayloadRequest

• GetApiPayloadResponse

Tabellen

Configs

Keine

Beispiele

Parameter	Beschreibung
ZS_REST_JsonApi_JobControl	Start und Überwachung einer Task-Verarbeitung über das REST-API
ZS_REST_JsonApi_Person	Synchrone und Asynchrone Erstellung einer Person über das REST-API