Web API: Expression - Revision history

Ollvihe at 20:33, 19 September 2022

2022-09-19T20:33:17Z

← Older revision		Revision as of 20:33, 19 September 2022
Line 19:		Line 19:
	Following parameter can be specified to the request url (query string):		Following parameter can be specified to the request url (query string):
	* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.		* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.
	* '''~~enableFullFunctionality~~''' (boolean): Same setting as in the [[Web_API:_Expression/query#Url_parameters\|/api/expression/query]].		* '''EnableFullFunctionality''' (boolean): Same setting as in the [[Web_API:_Expression/query#Url_parameters\|/api/expression/query]].

	== Example ==		== Example ==

Ollvihe at 20:32, 19 September 2022

2022-09-19T20:32:16Z

← Older revision		Revision as of 20:32, 19 September 2022
Line 19:		Line 19:
	Following parameter can be specified to the request url (query string):		Following parameter can be specified to the request url (query string):
	* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.		* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.
	* '''enableFullFunctionality''' (boolean): Same setting as in the [[Web_API:_Expression/query#Url_parameters\|expression query]].		* '''enableFullFunctionality''' (boolean): Same setting as in the [[Web_API:_Expression/query#Url_parameters\|/api/expression/query]].

	== Example ==		== Example ==

Ollvihe at 20:31, 19 September 2022

2022-09-19T20:31:52Z

← Older revision		Revision as of 20:31, 19 September 2022
Line 19:		Line 19:
	Following parameter can be specified to the request url (query string):		Following parameter can be specified to the request url (query string):
	* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.		* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.
			* '''enableFullFunctionality''' (boolean): Same setting as in the [[Web_API:_Expression/query#Url_parameters\|expression query]].

	== Example ==		== Example ==

Ollvihe at 08:48, 22 August 2022

2022-08-22T08:48:15Z

← Older revision		Revision as of 08:48, 22 August 2022
Line 7:		Line 7:
	</pre>		</pre>

	Following parameters can be used in the request body:		Following parameters can be used in the request body json object:
	* '''Expression''' (string): Expression to run.		* '''Expression''' (string): Expression to run.
	* '''SessionName''' (string): Identifying name for the calculation session.		* '''SessionName''' (string): Identifying name for the calculation session.
Line 17:		Line 17:
	* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].

	Following parameter can be specified in the request url:		Following parameter can be specified to the request url (query string):
	* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.		* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.

Ollvihe at 08:47, 22 August 2022

2022-08-22T08:47:31Z

← Older revision		Revision as of 08:47, 22 August 2022
Line 16:		Line 16:
	* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].

			Following parameter can be specified in the request url:
			* '''Timeout''' (integer): Timeout in seconds for the query. If the timeout is exceeded in a long-running query, the query execution is stopped and an error is returned. When no timeout is specified for the query, the server level global timeout is applied.

	== Example ==		== Example ==

Ollvihe at 23:33, 17 February 2022

2022-02-17T23:33:37Z

← Older revision		Revision as of 23:33, 17 February 2022
Line 2:		Line 2:

	<pre>		<pre>
	Url: POST /api/expression		Url: POST qprpa/api/expression
	Content-Type: application/json;charset=UTF-8		Content-Type: application/json;charset=UTF-8
	Body: (json object with parameters defined below)		Body: (json object with parameters defined below)

Ollvihe at 09:47, 11 October 2021

2021-10-11T09:47:23Z

← Older revision		Revision as of 09:47, 11 October 2021
Line 1:		Line 1:
	'''Expression''' method runs the given expression and returns the result ~~of the calculated expression~~ formatted as json. ~~Each~~ run ~~is stored to a~~ calculation session, ~~and the same session~~ can be continued in the next expression run~~. This way~~, for example initialized variables are available in the next run. ~~Calculatation~~ sessions are maintained in the server memory and dropper latest after 10 minutes if not used. ~~The calculation session is related~~ to the user session, so the calculations are not visible to other users or the same user if ~~login to~~ a new session. There can be multiple calculations sessions within the same user session.		'''Expression''' method runs the given expression and returns the result formatted as json. If the SessionName is provided, each run uses an existing calculation session, which can be continued in the next expression run, and for example initialized variables are available in the next run. Calculation sessions are maintained in the server memory and dropper latest after 10 minutes if not used. Calculation sessions are linked to the user session, so the calculations are not visible to other users or to the same user if using a new session. There can also be multiple calculations sessions within the same user session.

	<pre>		<pre>
Line 13:		Line 13:
	* '''ModelId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''ModelId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''FilterId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''FilterId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
			* '''Filter''' (object): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].		* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].

	== Example ==		== Example ==
	This example ~~runs~~ an ~~expression in the Model context~~ and ~~show model id and name. It also~~ assumes that there is a variable ''variable1'' ~~available~~ in ~~the~~ calculation session.		This example uses an existing calculation session ''UserSession1'', and assumes that there is a variable ''variable1'' in that calculation session.
	<pre>		<pre>
	{		{
	"contextType": "~~Model~~",		"contextType": "Generic",
	"expression": "~~`${~~variable1~~}: ${Id}: ${Name}`~~",		"expression": "variable1 + 1",
	"sessionName": "UserSession1",		"sessionName": "UserSession1"
	~~"modelId": 123~~
	}		}
	</pre>		</pre>

Ollvihe at 17:52, 10 October 2021

2021-10-10T17:52:13Z

← Older revision		Revision as of 17:52, 10 October 2021
Line 1:		Line 1:
	'''Expression''' method runs the given expression and returns the result of the calculated expression formatted as json. Each run is stored to a calculation session, and the same session can be continued in the next expression run. This way, for example initialized variables are available in the next run. Calculatation sessions are maintained in the server memory and dropper latest after 10 minutes if not used.		'''Expression''' method runs the given expression and returns the result of the calculated expression formatted as json. Each run is stored to a calculation session, and the same session can be continued in the next expression run. This way, for example initialized variables are available in the next run. Calculatation sessions are maintained in the server memory and dropper latest after 10 minutes if not used. The calculation session is related to the user session, so the calculations are not visible to other users or the same user if login to a new session. There can be multiple calculations sessions within the same user session.

	<pre>		<pre>
	Url: POST /api/expression		Url: POST /api/expression

Ollvihe at 17:48, 10 October 2021

2021-10-10T17:48:58Z

← Older revision		Revision as of 17:48, 10 October 2021
Line 9:		Line 9:
	* '''Expression''' (string): Expression to run.		* '''Expression''' (string): Expression to run.
	* '''SessionName''' (string): Identifying name for the calculation session.		* '''SessionName''' (string): Identifying name for the calculation session.
	* '''ContextType''' (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''ContextType''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''ModelId''' (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''ModelId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''FilterId''' (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''FilterId''' (integer): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].
	* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties\|/api/expression/query]].

	== Example ==		== Example ==

Ollvihe at 17:48, 10 October 2021

2021-10-10T17:48:38Z

← Older revision		Revision as of 17:48, 10 October 2021
Line 7:		Line 7:

	Following parameters can be used in the request body:		Following parameters can be used in the request body:
	* Expression (string): Expression to run.		* '''Expression''' (string): Expression to run.
	* SessionName (string): Identifying name for the calculation session.		* '''SessionName''' (string): Identifying name for the calculation session.
	* ContextType (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''ContextType''' (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].
	* ModelId (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''ModelId''' (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].
	* FilterId (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''FilterId''' (integer): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].
	* QueryIdentifier (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''QueryIdentifier''' (string): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].
	* CancelEarlierQueriesWithIdentifier (boolean): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].		* '''CancelEarlierQueriesWithIdentifier''' (boolean): Same as in [[Web_API:_Expression/query#Properties/api/expression/query\|]].

	== Example ==		== Example ==