...
GET taskruns
Get the taskRuns that comply to the filters.
Request parameters
onlyForecasts (boolean): option to toggle if only forecasts should be returned. Default false.
onlyCurrent (boolean): option to toggle if only current forecasts should be returned. Default false.
startDispatchTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for taskruns that have their dispatch time within this period.
endDispatchTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for taskruns that have their dispatch time within this period.
startForecastTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for taskruns that have their forecast time within this period.
endForecastTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for taskruns that have their forecast time within this period.
workflowId (string): Filter by an existing workflow id.
scenarioId (string): Filter by an existing whatsif scenario id.
- taskRunStatusIds (string): Filter taskruns using the taskrunstatus code value. For valid status codes see the section 'Get taskrunstatus' below.
documentVersion (string, 1.9 or up): File format version (optional). For example: 1.23
Response
- TaskRuns PI XML file content.
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/taskruns?workflowId=ImportObserved" |
Example response
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<TaskRuns xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_taskruns.xsd" version="1.23">
<timeZone>0.0</timeZone>
<taskRun taskRunId="0_0">
<forecast>false</forecast>
<status>completed fully successful</status>
<workflowId>ImportObserved</workflowId>
<dispatchTime date="2017-08-13" time="09:55:18"/>
<completionTime date="2017-08-13" time="10:21:35"/>
<time0 date="2017-08-13" time="09:45:00"/>
<outputStartTime date="1743-11-01" time="00:00:00"/>
<outputEndTime date="2017-08-01" time="00:00:00"/>
<user>rudie</user>
</taskRun>
</TaskRuns> |
...