client.workflows.list_executions

A method of the Workflows endpoint.

list_executions(id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List workflow executions

API URL: GET /workflows/{id}/executions

import civis
client = civis.APIClient()
response = client.workflows.list_executions(...)

Parameters:

idint

The ID for this workflow.

limitint, optional

Number of results to return. Defaults to 20. Maximum allowed is 50.

page_numint, optional

Page number of the results to return. Defaults to the first page, 1.

orderstr, optional

The field on which to order the result set. Defaults to id. Must be one of: id, updated_at, created_at.

order_dirstr, optional

Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

iteratorbool, optional

If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse

• idint

  The ID for this workflow execution.

• statestr

  The state of this workflow execution.

• mistral_statestr

  The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled

• mistral_state_infostr

  The state info of this workflow as reported by mistral.

• usercivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• started_atstr (time)

  The time this execution started.

• finished_atstr (time)

  The time this execution finished.

• created_atstr (time)

  The time this execution was created.

• updated_atstr (time)

  The time this execution was last updated.