Request a batch of status messages

[david4096]

Paraphrased from Bruce Hoff bruce.hoff@sagebase.org:

I would like a request that allows me to return a list of status messages for each ID requested, instead of performing get requests for each workflow being tracked.

[brucehoff]

This would allow a client to display for the user a dashboard of running workflows (retrieving, say, a page at a time rather than making a new request for each row of the table).

[adamstruck]

Couldn't this be achieved using the ListWorkflows endpoint with filtering?

[david4096]

@adamstruck yes! One way to close this would be to add a parameter workflow_ids that accepts an array of strings in the workflow_list_request and will only return workflows with the provided identifier in a ListWorkflowResponse.

[brucehoff]

Couldn't this be achieved using the ListWorkflows endpoint with filtering?

Yes, that is a good point. @david4096 also makes a good suggestion to determine the subset by passing a list of IDs. This relieves the WES implementation from having to implement filtering, sorting, etc. Please also see #23 which requests richer status than just a "state" string, (percent complete or other progress information). To me ideally the ListWorkflows would accept a list of IDs and return a list of maps (sets of key-value pairs) containing status metadata for the workflow. It seems to me that we would also need an endpoint to POST status information, that endpoint callable by the workflow itself.

[david4096]

Thanks @brucehoff , to actually close this, one would need to get the workflow logs using a filtered list, not just the list of workflows.

[cjllanwarne]

Pinging @vsmalladi and @patmagee - this is coming up as a would-be-useful feature for us too (updating CBAS to monitor run statuses in batches). I imagine that having some way to filter results would be useful for anyone who ends up with more than a handful of runs to query against in their engine. Would it be worthwhile me making an implementation PR to modify ListWorkflows with filter options as suggested above?

[vsmalladi]

@cjllanwarne I think its worth making the PR and then discussing where there might be issues.

[patmagee]

@cjllanwarne I agree, if you have the bandwidth could you add a PR for discussion?

[uniqueg]

For reference, there is a PR for filtering list outputs in TES as well: ga4gh/task-execution-schemas#170
Requirements and use cases should be almost identical