GET/results Enabling default start_time and final_time

[kefeimo]

Tag

Feature Required/ User Experience Improvement

Description

As mentioned in

project1-boptest/docs/workshops/BS21Workshop_20210831/Introduction_to_the_BOPTEST_framework.ipynb

Lines 748 to 749 in fef02e9

	"args = {'point_names':['reaTZon_y'],'start_time':-np.inf, 'final_time':np.inf}\n",
	"res = requests.put('{0}/results/{1}'.format(url, testid), data=args).json()['payload']\n",

, to achieve simulation results, we can use the following code snippet.

args = {'point_names':['reaTZon_y'],'start_time':-np.inf, 'final_time':np.inf}
res = requests.put('{0}/results'.format(url), data=args).json()['payload']

Note that we need to use -np.inf and np.inf to specify the whole range of the timestamp. Since np (aka numpy) is not native library of python, it introduces extra dependency.
In addition, arguably, it is easier for a user to get a full timestamp of the simulation result and filter it afterward rather than specifying it beforehand. Plus, it is not clear what would be the available start_time and final_time when using PUT/scenario.

Expected/proposal behavior

When leaving start_time, final_time empty, the RestAPI returns the full timestamp of the simulation result (i.e., set start_time==-np.inf, final_time==np.inf as default)