Sign in
Configuration Workflows

Get a configuration workflow run's full detail

Gets one run's full detail, including the full discovered payload behind its summary counts - fetched on demand (not part of the paginated run list, which stays lean) since a heavily-discovered run's payload can be sizeable.

get/api/south/{southId}/workflows/{workflowId}/runs/{runId}

Path parameters

southIdstring required
workflowIdstring required
runIdstring required

Response

The run, with its full discovered payload

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.

recordsOIBusRecord[] required

Example response

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

Changes

Changed in 5 of the 241 revisions of this API.23