Sign in
Workflow API

Get Workflow

Changed on

Returns the workflow with the given name in the database.

get/api/workflow/{name}

Request

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

Path parameters

namestring required

Query parameters

skip_groupsboolean
verboseboolean

Response

Successful Response

namestring required
uuidstring required
submitted_bystring required
cancelled_bystring nullable
specstring required
template_specstring required
logsstring required
eventsstring required
overviewstring required
parent_namestring nullable
parent_job_idinteger nullable
dashboard_urlstring nullable
grafana_urlstring nullable
tagsstring[]
submit_timestring date-time required
start_timestring date-time nullable
end_timestring date-time nullable
exec_timeoutnumber nullable
queue_timeoutnumber nullable
durationnumber nullable
queued_timenumber required
status'PENDING' | 'RUNNING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'FAILED_SUBMISSION' | 'FAILED_SERVER_ERROR' | 'FAILED_EXEC_TIMEOUT' | 'FAILED_QUEUE_TIMEOUT' | 'FAILED_CANCELED' | 'FAILED_BACKEND_ERROR' | 'FAILED_IMAGE_PULL' | 'FAILED_EVICTED' | 'FAILED_START_ERROR' | 'FAILED_START_TIMEOUT' | 'FAILED_PREEMPTED' required

Represents the status of a workflow.

outputsstring
poolstring nullable
backendstring nullable
app_ownerstring nullable
app_namestring nullable
app_versioninteger nullable
prioritystring required
labelsobject
warningsstring[]

Changes

  • b9d312a13f5dRevision changes
    • ○

      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

    • ○

      added the optional property to the response with the status

  • a8157dc3279dRevision changes
    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

      response property groups/items/tasks/items/exit_code list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/failure_message list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/initializing_start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/input_download_end_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/input_download_start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/node_name list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/output_upload_start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/pod_ip list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/processing_start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property groups/items/tasks/items/scheduling_start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

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

    • ▲

      the // response's property type changed from no type to string for status

    • ▲

      the //// response's property type changed from no type to string for status

    • ▲

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