Sign in
Configuration Workflows

List a configuration workflow's run history

Lists a configuration workflow's run history, most recent first, optionally narrowed by any combination of the filters below.

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

Path parameters

southIdstring required
workflowIdstring required

Query parameters

pagenumber double

The zero-based page number to fetch.

startstring

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 lower bound on startedAt - omit to not filter by a lower bound.

endstring

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 upper bound on startedAt - omit to not filter by an upper bound.

statusesstring

Comma-separated list of statuses to include (e.g. COMPLETED,ERRORED). Valid values: RUNNING, COMPLETED, ERRORED.

triggerTypesstring

Comma-separated list of trigger types to include (e.g. manual,scheduled). Valid values: manual, scheduled.

Response

Paginated list of runs

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "triggerType": "manual",
      "status": "COMPLETED",
      "triggeredBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      }
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}

Changes

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