...
GET taskrunstatus
Track the status of a workflow using the taskRunId.
Request parameters
- taskId (string, required): task Id of a workflow.
maxWaitMillis (integer) time in milliseconds to wait for response
Response
Status of the workflow task. Possible response codes are:
I = Invalid,
P = Pending,
T = Terminated,
R = running,
F = Failed,
C = Completed fully successful,
D = Completed partly successful,
A = Approved,
B = Approved partly successful
null
= No status available (produces when method call times-out)
Example request
Code Block |
---|
curl localhost:8080/FewsWebServices/rest/fewspiservice/v1/taskrunstatus?documentVersion=1.23&taskId=1_0 |
Example response
Code Block |
---|
C |
POST
runtasksruntask
Request parameters
- workflowId (string, required): Identifier of the task to run
- startTime (dateTime): Start of run period. Used for state selection period.
- timeZero (dateTime): Forecast time zero. If missing System time is used (optional)
- endTime (dateTime): End of run period. Used to define forecast length.
- coldStateId (string): Id of a coldstate. Can be used to force state selection (optional).
- scenarioId (string): Id of a predefined WhatIf scenario. Can be used to alter run parameters (optional).
- userId (string) User id of the user that runs the task.
- description (string): Descriptive text to identify run.
Body parameters
- piParametersXml (piXML url encoded): Contents of a Pi ModelParameters XML file. PI ModelParameters can be exported by the General Adapter to provide information to external models being run by FEWS. The xml file content has to be in application/x-www-form-urlencoded format.
Response
- String with the taskId of the task that is run.
Request parameters
- not applicable
Response
- TODO
Example request
Code Block |
---|
curl http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/runtasksruntask/?workflowId=ImportObserved&startTime=2014-01-01T00:00:00+0000&timeZero=2014-01-01T00:00:00+0000&endTime=2014-01-01T00:30:00+0000 -i -X POST -H 'Content-Type: application/x-www-form-urlencoded' -d '' |
Example response
Code Block |
---|
10 |
GET timeseriesmodifiers
Request parameters
locationIds (string)
moduleInstanceIds (string)
startTime (dateTime)
endTime (dateTime)
userId (string)
modifierTypeId (string)
active (boolean, default true)
userDefinedModifierDescriptionKeyValuePair (string)
- documentFormat (string)
Response
Example request
Code Block |
---|
curl http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/timeseriesmodifiers?onlyActiveModifiers=true |
Example response
Code Block |
---|
TODO |
...