Sign in
Configuration Workflows

Preview a configuration workflow's next run

Dry-runs a configuration workflow: identical discovery and classification as a real run, but nothing is written - no items, no point metadata, no run history entry. Discovery itself is a real round-trip to the data source, so this costs what a real run costs, minus the writes.

post/api/south/{southId}/workflows/{workflowId}/preview

Path parameters

southIdstring required
workflowIdstring required

Response

What the next run would find and how it would classify it

discoveredCountnumber double required
eligibleCountnumber double required
recordsOIBusRecord[] required

Remote (push-to-OIAnalytics) workflow only - the raw eligible records that would be sent, exactly as discovered, with no mapping or diffing applied. Empty for a local workflow.

Example response

{
  "entries": [
    {
      "status": "new"
    }
  ]
}

Changes

Changed in 9 of the 241 revisions of this API.45