SAP WF APIs bzgl. Workflows

SAP-Workflow-APIs bieten eine leistungsstarke Schnittstelle zur Integration und Steuerung von Workflows innerhalb von SAP-Systemen. Über OData- und REST-APIs lassen sich Workflows starten, Workitems abrufen und Bearbeitungsaktionen automatisieren. Beispielsweise ermöglicht die API /sap/opu/odata/sap/API_WORKFLOW_SRV das Anlegen und Verwalten von Workflow-Instanzen in SAP S/4HANA. Zudem können externe Anwendungen über die SAP Business Technology Platform (BTP) mit Workflows interagieren, um Genehmigungsprozesse nahtlos einzubinden. Diese APIs erleichtern die Prozessautomatisierung, verbessern die Systemintegration und optimieren die Effizienz von Geschäftsabläufen.

SAP Workflow Instance API

APIs für das Management von Workflow-Instanzen, einschließlich Erstellung und Statusaktualisierungen.

• Erstellung von Workflow-Instanzen: Startet neue Workflow-Instanzen.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances
  • JSON-Schema: { "definitionId": "string", "context": { "key": "value" }, "businessKey": "string" }
• Abfrage von Workflow-Instanzen: Listet Workflow-Instanzen mit Filtern nach Status und Definition.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances
  • JSON-Schema: { "instances": [ { "id": "string", "definitionId": "string", "status": "string" } ] }

SAP Workflow Definitions API

APIs zur Verwaltung von Workflow-Definitionen.

• Abrufen von Workflow-Definitionen: Listet verfügbare Workflow-Definitionen.
  • Endpunkt: /workflow-service/rest/v1/workflow-definitions
  • JSON-Schema: { "definitions": [ { "id": "string", "name": "string", "version": "integer" } ] }
• Aktivieren oder Deaktivieren von Definitionen: Steuert die Verfügbarkeit von Workflow-Definitionen.
  • Endpunkt: /workflow-service/rest/v1/workflow-definitions/{definitionId}/activate
  • JSON-Schema: Keine zusätzlichen Parameter erforderlich.

SAP Workflow Monitoring API

APIs zur Überwachung und Analyse von Workflows.

• Statusprüfung von Workflows: Gibt den Status von Workflow-Instanzen zurück.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances/{instanceId}/status
  • JSON-Schema: { "id": "string", "status": "string", "completed": "boolean" }
• Fehlerprotokoll: Ruft Fehler in Workflow-Instanzen ab.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances/{instanceId}/errors
  • JSON-Schema: { "errors": [ { "timestamp": "string", "message": "string" } ] }

SAP Workflow Context API

APIs zum Zugriff auf und zur Bearbeitung von Workflow-Kontextdaten.

• Abrufen von Kontextdaten: Ruft den Kontext einer Workflow-Instanz ab.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances/{instanceId}/context
  • JSON-Schema: { "context": { "key": "value" } }
• Aktualisieren von Kontextdaten: Aktualisiert den Kontext einer Workflow-Instanz.
  • Endpunkt: /workflow-service/rest/v1/workflow-instances/{instanceId}/context
  • JSON-Schema: { "context": { "key": "newValue" } }

SAP Workflow Events API

APIs zur Integration von Ereignissen in Workflows.

• Ereignisauslösung: Löst Ereignisse für Workflows aus.
  • Endpunkt: /workflow-service/rest/v1/workflow-events
  • JSON-Schema: { "event": "string", "data": { "key": "value" } }
• Abfrage von Ereignissen: Listet Ereignisse für bestimmte Workflows.
  • Endpunkt: /workflow-service/rest/v1/workflow-events
  • JSON-Schema: { "events": [ { "id": "string", "timestamp": "string", "data": { "key": "value" } } ] }

SAP Task API

APIs zur Verwaltung von Benutzeraufgaben innerhalb eines Workflows.

• Abrufen von Aufgaben: Ruft anstehende Aufgaben für einen Benutzer ab.
  • Endpunkt: /workflow-service/rest/v1/task-instances
  • JSON-Schema: { "tasks": [ { "id": "string", "name": "string", "status": "string", "context": { "key": "value" } } ] }
• Aktualisierung von Aufgaben: Aktualisiert den Status oder die Zuweisung von Aufgaben.
  • Endpunkt: /workflow-service/rest/v1/task-instances/{taskId}
  • JSON-Schema: { "status": "string", "context": { "key": "value" } }