Web API for Scripts - Revision history

Ollvihe: /* Get current run log */

2021-09-08T16:17:54Z

Get current run log

← Older revision		Revision as of 16:17, 8 September 2021
Line 36:		Line 36:
	Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

	There is an optional parameter '''startFromPosition''' which skips the beginning of the log and returns the tail of the log starting from that defined position as number of characters. This parameter is useful to get the tail of the log, for example when the start of the log has already been fetched earlier.		There is an optional parameter '''startFromPosition''' which skips the beginning of the log and returns the tail of the log starting from that defined position as number of characters. This parameter is useful to get the tail of the log, for example when the start of the log has already been fetched earlier. Position zero is the start of the log.

	=== Get last run log ===		=== Get last run log ===

Ollvihe: /* Get current run log */

2021-09-08T16:16:54Z

Get current run log

← Older revision		Revision as of 16:16, 8 September 2021
Line 31:		Line 31:
	=== Get current run log ===		=== Get current run log ===
	<pre>		<pre>
	GET api/scripts/runlog/current/{scriptId}		GET api/scripts/runlog/current/{scriptId}?startFromPosition=<number>
	</pre>		</pre>

	Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

			There is an optional parameter '''startFromPosition''' which skips the beginning of the log and returns the tail of the log starting from that defined position as number of characters. This parameter is useful to get the tail of the log, for example when the start of the log has already been fetched earlier.

	=== Get last run log ===		=== Get last run log ===

Ollvihe at 07:58, 6 May 2021

2021-05-06T07:58:53Z

← Older revision		Revision as of 07:58, 6 May 2021
Line 34:		Line 34:
	</pre>		</pre>

	Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: ~~Log~~, ~~Exceptions~~, ~~AdditionalData, OperationId~~. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

	=== Get last run log ===		=== Get last run log ===
Line 41:		Line 41:
	</pre>		</pre>

	Gets the last completed run log for script with given id. Returns an object with the following fields: ~~Log~~, ~~Exceptions~~, ~~AdditionalData, OperationId~~. Returns null if the script is has never been run yet. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the last completed run log for script with given id. Returns an object with the following fields: log, additionalData, operationId. Returns null if the script is has never been run yet. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

	=== Create script ===		=== Create script ===

Ollvihe: /* Script Entity */

2021-04-08T15:34:06Z

Script Entity

← Older revision		Revision as of 15:34, 8 April 2021
Line 10:		Line 10:
	* Description (string): Script description.		* Description (string): Script description.
	* Code (string): Script code.		* Code (string): Script code.
	* Language (string): Scripting language, either '''Expression''' or '''SQL'''.		* Language (string): Scripting language, either ''Expression'' or ''SQL''.

	==Methods==		==Methods==

Ollvihe: /* Script Entity */

2021-04-08T15:33:45Z

Script Entity

← Older revision		Revision as of 15:33, 8 April 2021
Line 10:		Line 10:
	* Description (string): Script description.		* Description (string): Script description.
	* Code (string): Script code.		* Code (string): Script code.
			* Language (string): Scripting language, either '''Expression''' or '''SQL'''.

	==Methods==		==Methods==

Ollvihe at 12:04, 9 March 2021

2021-03-09T12:04:59Z

← Older revision		Revision as of 12:04, 9 March 2021
Line 1:		Line 1:
	Scripts API is used to start and stop script runs and get the current or last completed script run log.		Scripts API is used to start and stop script runs and get the current or last completed script run log.

			Note that the [[Web API for Workspace Elements\|Workspace Elements API]] supports also scripts.

	==Script Entity==		==Script Entity==

Ollvihe at 11:49, 9 March 2021

2021-03-09T11:49:56Z

← Older revision		Revision as of 11:49, 9 March 2021
Line 31:		Line 31:
	</pre>		</pre>

	Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns ~~the~~ object with the following fields: Log, Exceptions, AdditionalData, OperationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the current run log for script with given id, i.e. a run that is currently in progress. Returns an object with the following fields: Log, Exceptions, AdditionalData, OperationId. Returns null if the script is not running. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

	=== Get last run log ===		=== Get last run log ===
Line 38:		Line 38:
	</pre>		</pre>

	Gets the last completed run log for script with given id. Returns ~~the~~ object with the following fields: Log, Exceptions, AdditionalData, OperationId. Returns null if the script is has never been run yet. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.		Gets the last completed run log for script with given id. Returns an object with the following fields: Log, Exceptions, AdditionalData, OperationId. Returns null if the script is has never been run yet. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.

	=== Create script ===		=== Create script ===
Line 45:		Line 45:
	</pre>		</pre>

	Creates a new script. Takes the script ~~object~~ in the body (id is ignored if specified). Returns the created script id. Returns ''Forbidden'' if script cannot be created.		Creates a new script. Takes the script entity in the body (id is ignored if specified). Returns the created script id. Returns ''Forbidden'' if script cannot be created due to lack of permissions.

	=== Edit script ===		=== Edit script ===
Line 52:		Line 52:
	</pre>		</pre>

	Updates an existing script. Takes the script ~~object~~ in the body. Returns ''NotFound'' error if script does not exist. Returns ''Forbidden'' if script cannot be modified.		Updates an existing script properties. Takes the script entity in the body. The Id property is mandatory, as the script is identified using it. Returns ''NotFound'' error if script does not exist. Returns ''Forbidden'' if script cannot be modified due to lack of permissions.

	=== Delete script ===		=== Delete script ===
Line 59:		Line 59:
	</pre>		</pre>

	Deletes a script with given id. Returns NotFound error if script does not exist. Returns ''Forbidden'' if script cannot be deleted.		Deletes a script with given id. Returns NotFound error if script does not exist. Returns ''Forbidden'' if script cannot be deleted due to lack of permissions.

	[[Category: QPR ProcessAnalyzer]]		[[Category: QPR ProcessAnalyzer]]

Ollvihe: /* Edit script */

2021-03-09T11:47:55Z

Edit script

← Older revision		Revision as of 11:47, 9 March 2021
Line 52:		Line 52:
	</pre>		</pre>

	Updates an existing script. Takes the script object in the body. Returns NotFound error if script does not exist. Returns ''Forbidden'' if script cannot be modified.		Updates an existing script. Takes the script object in the body. Returns ''NotFound'' error if script does not exist. Returns ''Forbidden'' if script cannot be modified.

	=== Delete script ===		=== Delete script ===

Ollvihe: /* Script Entity */

2021-03-09T11:47:05Z

Script Entity

← Older revision		Revision as of 11:47, 9 March 2021
Line 3:		Line 3:
	==Script Entity==		==Script Entity==
	The scripts API is based on the '''script''' entity, which has the following properties:		The scripts API is based on the '''script''' entity, which has the following properties:
	- Id (integer): Script id		* Id (integer): Script id.
	- ProjectId (integer): project ~~id (~~if ~~empty,~~ script belongs to system level)		* ProjectId (integer): project id. Empty if script belongs to system level.
	- Name (string): name		* Name (string): Script name.
	- Description (string): description		* Description (string): Script description.
	- Code (string): code		* Code (string): Script code.

	==Methods==		==Methods==

Ollvihe at 11:46, 9 March 2021

2021-03-09T11:46:27Z

@@ Line 1: / Line 1: @@
 Scripts API is used to start and stop script runs and get the current or last completed script run log.
 ==Methods==
@@ Line 31: / Line 39: @@
 Gets the last completed run log for script with given id. Returns the object with the following fields: Log, Exceptions, AdditionalData, OperationId. Returns null if the script is has never been run yet. Requires the global RunScript permission. Returns NotFound if a script does not exist, or Forbidden if current user has no access to the script.
 [[Category: QPR ProcessAnalyzer]]