Skip to content
  • There are no suggestions because the search field is empty.

How can we manually raise OFS-Flow forms via API?

Explains how to use the OFS-Flow alert-raising API to create Flow records manually, semi-automatically, or fully automatically.

Every OFS-Flow subscription includes an API that lets you automate raising Flow records — manually, semi-automatically, or fully automatically.

The alert-raising API is available at:

https://{hostname}/serviceengine/alertraise?configUID=...&workcentre=...&time=...

To call this API, the account you authenticate with needs the alertraise permission. Administrators typically have this, as does anyone who can already manually raise a Flow form from the console.

What you'll need

To raise a new alert via the API, you need three parameters, each properly URL-encoded:

  • The Config UID of the alert you want to raise
  • The Workcentre you want the new alert associated with
  • The Time you want the alert raised at

Config UID

This is the GUID shown as API Key on the alert's General tab in Fusion Manager, once the alert has been saved.

Workcentre

  • If you're licensed for Line Independent Flows and want to raise the alert without a specific line, use NOWORKCENTRE001.
  • For an alert tied to a licensed production line, use that line's workcentre code — the capital-letter-plus-3-digit code that sits between your server address and /console/ in your OFS Console URL.

Time

The time must be a Unix timestamp — the number of milliseconds since the Unix Epoch. In almost all cases, use the current time. Public tools like Epoch Converter are fine for calculating this, since a timestamp on its own isn't sensitive.

  • A past timestamp is accepted, and the alert is transitioned through its workflow in line with that creation time.
  • A future timestamp is rejected — the server doesn't support queuing alerts ahead of time via this API.

Testing your request

Once you have your three parameters, combine them with the base URL above. An API client like Postman works well, or you can test directly from a web browser.

Each call creates a new alert, so test carefully to avoid raising duplicates. Since the URL contains your Config UID, avoid pasting it into a public online encoder — encode it locally, or let your API client (e.g. Postman) handle it automatically.

Automating form creation

Combine this API with an external trigger — a hook in SAP, a factory-floor sensor, or similar — to raise Flow forms automatically. The API can be called from anywhere with access to the OFS server, with the workcentre, alert, and time values populated by your own systems.