Endpoints Included in the Flow Extension API

Query these endpoints to interrupt the flow of a document using the Flow Extension API.

The Flow Extension API includes the following endpoints:

Endpoint

Description

POST /action/flowextensions/{flowExtensionId}/events/{eventId}/halt

Complete the flow extension and rejects the document by returning it to the sender in 'FAILED' status.

POST /actions/flowextensions/{flowExtensionId}/events/acknowledge

Acknowledge receipt of an Event retrieved using the Get Next Event API.

POST /action/flowextensions/{flowExtensionId}/events/{eventId}/complete

For flow extensions in the non-suspend use case. Indicate completion of the flow extension processing for the event.

POST /action/flowextensions/{flowExtensionId}/events/{eventId}/resume

Complete the flow extension and allows the document to continue with its normal processing flow.

POST /flowextensions/{flowExtensionId}/events/{eventId}

Post a comment or attachments to a document event.

GET /flowextensions/{flowExtensionId}/events

Retrieve the most recent events from Extension Queue.

GET /flowextensions/{flowExtensionId}/events/{eventId}/eventdata

Retrieve relevant document data from SAP Business Network for a specific event that external party has received a notification for.

GET /flowextensions/{flowExtensionId}/events/{eventId}/eventdata/attachment

Retrieve relevant document data for a specific document based on the document contentid (cid) from SAP Business Network for a specific event that external party has received a notification for.