...
Items shown between curly braces are parameters that you would configure as part of the call.
Interface Address | Function | Example |
|---|---|---|
/echo/{message} |
A test location that will return the message: You Typed: {message} for whatever was pass in. This location is useful for checking the server is up and responsive. | -a "net.pipe://localhost/PipeReverse" |
/projectDirectory/{*projectDirectory} |
| Directory in which to look for projects | --baseSIUnits |
/create |
| Starts a new server and returns a {instance} string that should be passed to most other calls to communicate with this created server. | -c "c:\StateFiles\state.txt" |
/load?instance={instance}&project={projectName}&scenario={scenarioName} |
| Path to the project, or project name on server and optional scenario within that project. | -d "c:\ProjectFiles" |
/saveas?instance={instance}&project={projectNewName}&folderPath={folderPath} |
| Save the loaded project after the run is complete to the specified path and file. The string argument cannot be empty, and the path provided must be an existing directory and have saving permissions for the current user. | |
/units?instance={instance}&si={useSIUnits} |
| Ignore units set within project and output base SI units | |
/project?instance={instance} |
| Returns the project file an scenario name of the loaded project | -l "plugin.dll" |
/run?instance={instance} |
| Executes the active scenario from its current location to the end | -m Client or -m Server |
/step?instance={instance} |
| Moves forward 1 time step in the active scenario | -o "output.res.csv" for CSV or -o "output.nc" |
/getStep?instance={instance} |
Returns the current step and the total number of steps in the active scenario | -p "projectName.rspr |
/metaParameters?instance={instance} |
Which results to return. This can appear multiple times.
| Info | ||
|---|---|---|
| ||
| Note: By default, all recorded results are saved into the specified output file. When this options is used, it only allows you to reduce the number of results saved out. Requested results must be set to record in the project file. To specify the output file name, save the result to a file with a .res.csv extension. Use the column name for the time series. |
Get the active Functions (also calledmeta-parameter for calibration) | |
/metaParameter?instance={instance}&name={parameterName}&value={value} |
Set the value of a Function (also calledmeta-parameter for calibration) | |
/allTimeSeries?instance={instance} |
| Returns all the result timeseries | --reset |
/timeSeries?instance={instance}&name={parameterName} |
| Returns a specific timeseries | --current |
/timeStepValue?instance={instance}&name={parameterName} |
returns the last value of a |
particular timeseries | -v "$metaparam=25", or -v "$anotherMetaParam=2.3" |
/reset?instance={instance} |
| Reset the loaded project |
| . | |
/finish?instance={instance} |
| Destroys the service associated with the specified instance identifer |