Starting expecco via Command Line/rest/en - Versionsgeschichte

Cg: /* API Functions */

2019-09-03T09:35:15Z

API Functions

← Nächstältere Version		Version vom 3. September 2019, 09:35 Uhr
Zeile 18:		Zeile 18:
	=== API Functions ===		=== API Functions ===

	A ~~very~~ useful REST-entry is the "<code>protocolInfo</code>" request, which returns a description of all supported REST call entries:		A useful REST-entry is the "<code>protocolInfo</code>" request, which returns a description of all supported REST call entries:

	==== ProtocolInfo Request ====		==== ProtocolInfo Request ====

Cg: /* Start expecco with REST Server enabled */

2019-09-03T09:34:58Z

Start expecco with REST Server enabled

← Nächstältere Version		Version vom 3. September 2019, 09:34 Uhr
Zeile 5:		Zeile 5:
	=== Start expecco with REST Server enabled ===		=== Start expecco with REST Server enabled ===

	The service can be started using the command line arguments -- server or --service. Please refer to the detailed description of [[Starting_expecco_via_Command_Line#Command_Line_Options\|the command line arguments]] for more details. Otherwise it is possible to start the service within the expecco IDE. In the ~~Main~~ ~~Menu~~ ~~you~~ ~~will find~~ the menu entries "Extras/Webservices/Test Execution Client For expecco ALM (SOAP)" Start... and Stop. The ~~menu entry~~ "Start" opens a dialog where you can choose the port number should be used by the server. If you choose start the SOAP and REST Services will be started. ~~With the menu entry~~ "Stop" ~~the~~ ~~server~~ ~~will be~~ ~~stopped~~.		The service can be started using the command line arguments -- server or --service. Please refer to the detailed description of [[Starting_expecco_via_Command_Line#Command_Line_Options\|the command line arguments]] for more details. Otherwise it is possible to start the service within the expecco IDE. the main menu contains a the menu entries "''Extras''"→ "''Webservices''" → "''Test Execution Client For expecco ALM (SOAP)''" → "''Start...''" and "''Stop''". The "''Start...''" item opens a dialog where you can choose the port number should be used by the server. If you choose start the SOAP and REST Services will be started. The "''Stop''" item terminates the service.

	=== Introduction ===		=== Introduction ===

Mawalch am 11. Juni 2017 um 20:47 Uhr

2017-06-11T20:47:23Z

Änderungen zeigen

Mawalch: Spelling fixes.

2017-05-18T13:58:51Z

Spelling fixes.

Ab am 2. April 2017 um 12:36 Uhr

2017-04-02T12:36:36Z

← Nächstältere Version		Version vom 2. April 2017, 12:36 Uhr
Zeile 42:		Zeile 42:
	* "Return" - the type of return data. Same possible values as the argument description.		* "Return" - the type of return data. Same possible values as the argument description.

	For example, the ~~current~~ expecco implementation returns the following JSON object:		For example, the expecco 2.11 implementation returns the following JSON object:

	<PRE>		<PRE>

Ab am 1. April 2017 um 16:53 Uhr

2017-04-01T16:53:42Z

← Nächstältere Version		Version vom 1. April 2017, 16:53 Uhr
Zeile 322:		Zeile 322:
	* Parameters - optional Array. For future expansion		* Parameters - optional Array. For future expansion

	==== ~~expecco~~ ~~exit~~ Request ====		==== Exit expecco Request ====

	"host:9090/expeccoService/rest/expeccoExit"		"host:9090/expeccoService/rest/expeccoExit"

Ab am 1. April 2017 um 16:52 Uhr

2017-04-01T16:52:40Z

← Nächstältere Version		Version vom 1. April 2017, 16:52 Uhr
Zeile 65:		Zeile 65:
	"Comment":"start execution; return ticketID.",		"Comment":"start execution; return ticketID.",
	"Return":"Dictionary",		"Return":"Dictionary",
	"Argument":"(ID:String, SuiteID:String, Suite:String, SuiteURI:String, Environment:~~Dictionary~~, ~~TestPlans~~:Array, Resources:Array, Parameters:Array)"		"Argument":"(ID:String, SuiteID:String, Suite:String, SuiteURI:String, Environment:Array, TestPlanIDs:Array, Resources:Array, Parameters:Array)"
	},		},
	{		{
Zeile 72:		Zeile 72:
	"Comment":"start execution of a well known suite; return ticketID.",		"Comment":"start execution of a well known suite; return ticketID.",
	"Return":"Dictionary",		"Return":"Dictionary",
	"Argument":"(ID:String, SuiteFileName:String, Environment:~~Dictionary~~, ~~TestPlans~~:Array, Resources:Array, Parameters:Array)"		"Argument":"(ID:String, SuiteFileName:String, Environment:Array, TestPlanIDs:Array, Resources:Array, Parameters:Array)"
	},		},
	{		{
Zeile 79:		Zeile 79:
	"Comment":"start execution of a well known suite; return ticketID.",		"Comment":"start execution of a well known suite; return ticketID.",
	"Return":"Dictionary",		"Return":"Dictionary",
	"Argument":"(ID:String, SuiteFileName:String, Environment:~~Dictionary~~, ~~TestPlans~~:Array, Resources:Array, Parameters:Array)"		"Argument":"(ID:String, SuiteFileName:String, Environment:Array, TestPlanNames:Array, Resources:Array, Parameters:Array)"
			},
			{
			"Name":"expeccoExit",
			"Request":"GET",
			"Comment":"Exit the expecco application."
	},		},
	{		{
Zeile 96:		Zeile 101:
	{		{
	"Name":"killExecution",		"Name":"killExecution",
	"Request":"~~GET~~",		"Request":"PUT",
	"Comment":"kill execution of an execute job; argument is ticketID.",		"Comment":"kill execution of an execute job; argument is ticketID.",
	"Argument":"(ID:String)"		"Argument":"(ID:String)"
Zeile 114:		Zeile 119:
	{		{
	"Name":"removeTicket",		"Name":"removeTicket",
	"Request":"~~GET~~",		"Request":"PUT",
	"Comment":"give up execution of an execute job; if required, kill the job. argument is ticketID.",		"Comment":"give up execution of an execute job; if required, kill the job. argument is ticketID.",
	"Argument":"(ID:String)"		"Argument":"(ID:String)"
Zeile 317:		Zeile 322:
	* Parameters - optional Array. For future expansion		* Parameters - optional Array. For future expansion

			==== expecco exit Request ====

			"host:9090/expeccoService/rest/expeccoExit"

			Send back a response and exit expecco.

			No argument, no return

	=== Examples ===		=== Examples ===

Ab: /* Status Request */

2017-03-13T08:36:36Z

Status Request

← Nächstältere Version		Version vom 13. März 2017, 08:36 Uhr
Zeile 240:		Zeile 240:


	==== Status Request ====		==== Execution Status Request ====

	"host:9090/expeccoService/rest/getExecutionInfo"		"host:9090/expeccoService/rest/getExecutionInfo"

Ab am 13. März 2017 um 08:36 Uhr

2017-03-13T08:36:11Z

← Nächstältere Version		Version vom 13. März 2017, 08:36 Uhr
Zeile 244:		Zeile 244:
	"host:9090/expeccoService/rest/getExecutionInfo"		"host:9090/expeccoService/rest/getExecutionInfo"

	This query returns status information about an ongoing execution. Its single parameter field must contain a ticketId as described in the execute request.		This query returns status information about an ongoing or finished execution. Its single parameter field must contain a ticketId as described in the execute request.

			The argument is a JSON object with the following fields:
			* ID - mandatory; job id

			==== Wait for test execution finished Request ====

			"host:9090/expeccoService/rest/waitForExecutionResult"

			This request wait until the execution with the given job/ticket id is finished. After that it returns the same information as the request getExecutionInfo. With this request no polling on client side is necessary. On the other hand if the client poll the execution state with getExecutionInfo it is possible to fetch information about the progress of the execution from the response.

	The argument is a JSON object with the following fields:		The argument is a JSON object with the following fields:
Zeile 268:		Zeile 277:
	The argument is a JSON object with the following fields:		The argument is a JSON object with the following fields:
	* ID - mandatory; job id		* ID - mandatory; job id


	==== Get List of available Testsuites Request ====		==== Get List of available Testsuites Request ====
Zeile 295:		Zeile 305:


			==== Download Request ====

	~~==== Download Request~~ "/expeccoService/rest/download" ~~====~~		"host:9090/expeccoService/rest/download"

	This is similar to the suite transmission scheme described in the execute request. However, the suite is not executed.		This is similar to the suite transmission scheme described in the execute request. However, the suite is not executed.

	The argument is a JSON object with the following fields:		The argument is a JSON object with the following fields:
	* SuiteID - mandatory String; the suite's ID		* SuiteID - mandatory String; the suite's ID
Zeile 305:		Zeile 317:
	* Parameters - optional Array. For future expansion		* Parameters - optional Array. For future expansion


	The operation is the same as described in the previous SOAP section.
	=== Examples ===		=== Examples ===

Zeile 480:		Zeile 492:
	}		}
	</PRE>		</PRE>


	==== Perl Client ====		==== Perl Client ====
			This is a small perl example. It starts a test execution on the expecco server and wait until execution is finished. In case of successful HTPP Response (200) the result is printed.

	<PRE>		<PRE>
	use REST::Client;		use REST::Client;

Ab: /* Execution by Suite File Name Request */

2017-03-13T08:21:36Z

Execution by Suite File Name Request

← Nächstältere Version		Version vom 13. März 2017, 08:21 Uhr
Zeile 154:		Zeile 154:
	* Parameters - optional		* Parameters - optional

	ID:		ID:<br>
	The ID is an unique identifier which can be used later to retrieve the execution state, results and execution logs. The ID have to be passed as JSON String.		The ID is an unique identifier which can be used later to retrieve the execution state, results and execution logs. The ID have to be passed as JSON String.

Zeile 160:		Zeile 160:
	The testsuite file must be present/reachable by the expecco slave. It may be either an absolute pathname (typically on a shared network drive) or a relative filename. If a relative file name is given, it will be searched in the folder specified with the "''--suiteDirectory''" command line argument. The SuiteFileName have to be passed as JSON String.		The testsuite file must be present/reachable by the expecco slave. It may be either an absolute pathname (typically on a shared network drive) or a relative filename. If a relative file name is given, it will be searched in the folder specified with the "''--suiteDirectory''" command line argument. The SuiteFileName have to be passed as JSON String.

	Environment:		Environment:<br>
	The suite environment can be setup/modified with this argument. The environment have to be passed as JSON Array with a list of environment key value pairs. First value of a pair is the environment key second the value.		The suite environment can be setup/modified with this argument. The environment have to be passed as JSON Array with a list of environment key value pairs. First value of a pair is the environment key second the value.

	TestPlans:		TestPlans:<br>
	A JSON Array with a list of testplan names. The testplans will be executed in the order defined in the array. If no testplan is given, all testplans ~~found~~ in the suite will be executed.		A JSON Array with a list of testplan names. The testplans will be executed in the order defined in the array. If no testplan is given, all testplans included in the suite will be executed.

	Resources:		Resources:<br>
	Within this argument you can pass resource descriptions for the execution.		Within this argument you can pass resource descriptions for the execution.

	Parameters:		Parameters:<br>
	If the "Parameters" field is present, it must be a JSON array containing alternating key-value elements.		If the "Parameters" field is present, it must be a JSON array containing alternating key-value elements.
	Currently supported keys are:		Currently supported keys are:

← Nächstältere Version		Version vom 18. Mai 2017, 13:58 Uhr
Zeile 5:		Zeile 5:
	=== Start expecco with REST Server enabled ===		=== Start expecco with REST Server enabled ===

	The service can be started using the command line arguments -- server or --service. Please refer to the detailed description of [[Starting_expecco_via_Command_Line#Command_Line_Options\|the command line arguments]] for more details. Otherwise it is possible to start the service within the expecco IDE. In the Main Menu you will find the menu entries "Extras/Webservices/Test Execution Client For ~~expeccoALM~~ (SOAP)" Start... and Stop. The menu entry "Start" opens a dialog where you can choose the port number should be used by the server. If you choose start the SOAP and REST Services will be started. With the menu entry "Stop" the server will be stopped.		The service can be started using the command line arguments -- server or --service. Please refer to the detailed description of [[Starting_expecco_via_Command_Line#Command_Line_Options\|the command line arguments]] for more details. Otherwise it is possible to start the service within the expecco IDE. In the Main Menu you will find the menu entries "Extras/Webservices/Test Execution Client For expecco ALM (SOAP)" Start... and Stop. The menu entry "Start" opens a dialog where you can choose the port number should be used by the server. If you choose start the SOAP and REST Services will be started. With the menu entry "Stop" the server will be stopped.

	=== Introduction ===		=== Introduction ===

	The expecco REST service supports nearly the same set of operations as the [[Starting_expecco_via_Command_Line/en#Expecco_SOAP_Service_Interface\|expecco SOAP service]], but uses a much more lightweight approach in its parameter encoding. It is both easier to implement on the client side, and also faster than SOAP, due to the minimal encoding/decoding overhead.		The expecco REST service supports nearly the same set of operations as the [[Starting_expecco_via_Command_Line/en#Expecco_SOAP_Service_Interface\|expecco SOAP service]], but uses a much more lightweight approach in its parameter encoding. It is both easier to implement on the client side, and also faster than SOAP, due to the minimal encoding/decoding overhead.
	Expecco REST calls are HTTP-GET or HTTP-PUT requests, possibly with attached JSON encoded argument data. For requests with response data, the data are also JSON encoded. The ~~http~~ response code on success is 200.		Expecco REST calls are HTTP-GET or HTTP-PUT requests, possibly with attached JSON encoded argument data. For requests with response data, the data are also JSON encoded. The HTTP response code on success is 200.

	The operation is determined by the URI: the last component is the operation name to be executed.		The operation is determined by the URI: the last component is the operation name to be executed.

	A description of the supported REST calls can be ~~aqcuired~~ from the running service via		A description of the supported REST calls can be acquired from the running service via
	"<code>host:9090/expeccoService/rest/protocolInfo</code>".		"<code>host:9090/expeccoService/rest/protocolInfo</code>".

Zeile 25:		Zeile 25:
	"host:9090/expeccoService/rest/protocolInfo"		"host:9090/expeccoService/rest/protocolInfo"

	All REST services from eXept products support the protocolInfo request (see also ~~expeccoALM~~-Rest service).		All REST services from eXept products support the protocolInfo request (see also expecco ALM-Rest service).
	It allows for a client to dynamically adapt to newer versions.		It allows for a client to dynamically adapt to newer versions.

Zeile 210:		Zeile 210:

	The .ets file can be either passed down as data (in the Suite field), or expecco can be ordered to fetch the suite via		The .ets file can be either passed down as data (in the Suite field), or expecco can be ordered to fetch the suite via
	~~http~~ from the given SuiteURI. If Suite is empty or missing, expecco tries to fetch the .ets file via the SuiteURI.		HTTP from the given SuiteURI. If Suite is empty or missing, expecco tries to fetch the .ets file via the SuiteURI.
	If both fields are empty, expecco will run the test if and only if the suite is already present in its ~~cach~~ folder.		If both fields are empty, expecco will run the test if and only if the suite is already present in its cache folder.
	Thus, you can optimize execute requests, by either always provide a SuiteURI (instead of the suite data),		Thus, you can optimize execute requests, by either always provide a SuiteURI (instead of the suite data),
	or - if the client cannot provide the suite via HTTP, but has to send it as data - by first sending an execute request		or - if the client cannot provide the suite via HTTP, but has to send it as data - by first sending an execute request