Sign in
Workflow API

List Workflow

Changed on
get/api/workflow

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

usersstring[] nullable
namestring nullable
statusesWorkflowStatus[] nullable
offsetinteger
limitinteger
order'ASC' | 'DESC'

Represents the list order for the database.

all_usersboolean
poolsstring[] nullable
all_poolsboolean
submitted_beforestring date-time nullable
submitted_afterstring date-time nullable
tagsstring[] nullable
appstring nullable
priorityWorkflowPriority[] nullable
labelstring[] nullable

Workflow label selector: key=value with optional * wildcards and (a|b) alternatives, for example key=(team_|osmo_) or key=team_(a|b). Repeat for AND semantics.

no_labelstring[] nullable

Label key that must be absent from the workflow; workflows without any labels match. Repeat for AND semantics.

Headers

x-osmo-userstring nullable

Response

Successful Response

more_entriesboolean required

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the new optional query request parameter label

    • ○

      added the new optional query request parameter no_label

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • ▲

      the query request parameter order was restricted to a list of enum values

    • ▲

      response property workflows/items/app_name list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/app_owner list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/app_version list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/dashboard_url list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/duration list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/end_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/error_logs list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/grafana_url list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/pool list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property workflows/items/start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      the // response's property format changed from time-delta to no format for status

    • ○

      added the new enum value ASC to the query request parameter order

    • ○

      added the new enum value DESC to the query request parameter order

    • ○

      header request parameter x-osmo-user list-of-types was widened by adding types null

    • ○

      query request parameter app list-of-types was widened by adding types null

    • ○

      query request parameter name list-of-types was widened by adding types null

    • ○

      query request parameter pools list-of-types was widened by adding types null

    • ○

      query request parameter priority list-of-types was widened by adding types null

    • ○

      query request parameter statuses list-of-types was widened by adding types null

    • ○

      query request parameter submitted_after list-of-types was widened by adding types null

    • ○

      query request parameter submitted_before list-of-types was widened by adding types null

    • ○

      query request parameter tags list-of-types was widened by adding types null

    • ○

      query request parameter users list-of-types was widened by adding types null

    • ○

      for the header request parameter x-osmo-user, the type was generalized from string to no type

    • ○

      for the query request parameter app, the type was generalized from string to no type

    • ○

      for the query request parameter name, the type was generalized from string to no type

    • ○

      for the query request parameter order, the type was generalized from no type to string

    • ○

      for the query request parameter pools, the type was generalized from array to no type

    • ○

      for the query request parameter priority, the type was generalized from array to no type

    • ○

      for the query request parameter statuses, the type was generalized from array to no type

    • ○

      for the query request parameter submitted_after, the type was generalized from string to no type, and format from date-time to no format

    • ○

      for the query request parameter submitted_before, the type was generalized from string to no type, and format from date-time to no format

    • ○

      for the query request parameter tags, the type was generalized from array to no type

    • ○

      for the query request parameter users, the type was generalized from array to no type