jobs

Changed on

Paginated job list only (histograms via separate job_list_histograms.

endpoint).

Args: request (Any): Request passed to this helper.

Returns: Any: Value produced by this call (type depends on inputs).

Examples:

job_list(None) # doctest: +SKIP

get/api/jobs/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in cookie sessionid
    • none

Query parameters

accountstring

Comma-separated project/account names (exact match, OR).

end_time__datestring
hoststring
include_filter_optionsinteger

When 0, omit filter_options from the response (SPA loads them via GET /api/jobs/filter_options/). Default 1.

order_bystring
pageinteger
performance_sort_rankstring

Comma-separated performance status ranks 0-5 (OR).

queuestring

Comma-separated queue names (OR).

statestring

Comma-separated major terminal status group keys (OR) - completed, failed, canceled, preempted, timeout.

usernamestring

Comma-separated usernames (OR within dimension).

Response

njinteger
filter_summarystring[]
histogramsobject
qnamestring
order_bystring
current_pathstring nullable

Changes

  • 127b8fbd1b3dRevision changes
    • info

      added the new optional query request parameter include_filter_options

  • 4e28fe517091Revision changes
    • warning

      deleted the query request parameter date

    • warning

      deleted the query request parameter order

    • warning

      deleted the query request parameter sort

    • warning

      deleted the query request parameter year

    • info

      added the new optional query request parameter end_time__date

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter performance_sort_rank

    • info

      added the new optional query request parameter state

    • info

      added the optional property to the response with the status