Sign in
Configuration Workflows

Run a configuration workflow now

Runs a configuration workflow now: discovers the south connector's data source, decides which discovered entries warrant a change, and acts on them (creating/updating/orphaning items and/or writing remote point metadata) - on the south connector's live, already-running instance.

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

Path parameters

southIdstring required
workflowIdstring required

Response

The completed (or errored) run

discoveredCountnumber double required
eligibleCountnumber double required
createdCountnumber double required
updatedCountnumber double required
disabledCountnumber double required
pushedCountnumber double required
idstring required
workflowIdstring required
triggerType'manual' | 'scheduled' required
status'RUNNING' | 'ERRORED' | 'COMPLETED' required
startedAtstring required
completedAtstring nullable required

Null while status is RUNNING.

errorstring nullable required

Set only when status is ERRORED.

Example response

{
  "triggerType": "manual",
  "status": "COMPLETED",
  "triggeredBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  }
}

Changes

Changed in 10 of the 241 revisions of this API.56