ElementaryBlock Element RESTCall/en - Versionsgeschichte

Cg: /* Expecco's Builtin REST Service */

2019-09-03T09:38:46Z

Expecco's Builtin REST Service

← Nächstältere Version		Version vom 3. September 2019, 09:38 Uhr
Zeile 74:		Zeile 74:

	Expecco itself includes a REST service, which is normally used by quality management systems (such as expeccoALM) to remote-control test executions running on a test-slave machine.		Expecco itself includes a REST service, which is normally used by quality management systems (such as expeccoALM) to remote-control test executions running on a test-slave machine.
	This service is started via the "Extras" - "WebServices" - "Expecco Remote Service (REST)" menu item.		This service is started via the "''Extras''" → "''WebServices''" → "''Expecco Remote Service (REST)''" menu item.
	Once started, it will respond to REST requests at the endpoint URL "localhost:9090/remote" and provide various		Once started, it will respond to REST requests at the endpoint URL "localhost:9090/remote" and provide various
	procedure- and query- calls. One such service endpoint is "/ping", which returns JSON encoded version information of the running expecco (this REST call is actually used by expeccoALM to check for slave-machine availability).		procedure- and query- calls. One such service endpoint is "/ping", which returns JSON encoded version information of the running expecco (this REST call is actually used by expeccoALM to check for slave-machine availability).

2018-04-23T18:15:40Z

Default Values

← Nächstältere Version		Version vom 23. April 2018, 18:15 Uhr
Zeile 30:		Zeile 30:

	=== Default Values ===		=== Default Values ===
	If no endPoint-URL is provided (i.e. both the field in the declaration page was left empty, and no value is provided at the "__url__" pin, expecco looks for an environment variable named "REST_URL".		If no endPoint-URL is provided (i.e. both the field in the declaration page was left empty, and no value is provided at the "__url__" pin), expecco looks for an environment variable named "REST_URL".

	== URL Parameters ==		== URL Parameters ==

2018-04-23T18:02:41Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 18:02 Uhr
Zeile 93:		Zeile 93:
	[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST Test/Demo]]		[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST Test/Demo]]

	Then, run it and take ~~alook~~ at the output pins:		Then, run it and take a look at the output pins:

	[[Datei:Rest_expecco_version_run.png\|600px\|REST Output]]		[[Datei:Rest_expecco_version_run.png\|600px\|REST Output]]

2018-04-23T18:02:23Z

Examples

← Nächstältere Version		Version vom 23. April 2018, 18:02 Uhr
Zeile 67:		Zeile 67:
	The responseCode and mimeType are already extracted from the response object and always provided at the corresponding output pins.		The responseCode and mimeType are already extracted from the response object and always provided at the corresponding output pins.

	== Examples ==		== Out-of-the-Box Examples ==

	=== Getting the Expecco Version ===		=== Getting the Expecco Version ===

2018-04-23T18:01:25Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 18:01 Uhr
Zeile 103:		Zeile 103:

	[[Datei:Rest_expecco_version_extractVersion.png\|600px\|New Test/Demo Setup]]		[[Datei:Rest_expecco_version_extractVersion.png\|600px\|New Test/Demo Setup]]

			and find the version string at that action's output:

			[[Datei:Rest_expecco_version_runExtractVersion.png\|600px\|Version String]]

2018-04-23T18:00:22Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 18:00 Uhr
Zeile 101:		Zeile 101:
	The later contains a key-value pair for "expeccoVersion".		The later contains a key-value pair for "expeccoVersion".
	To further extract individual fields, use the "Collection [ElementAt]" action, with "expeccoVersion" as key:		To further extract individual fields, use the "Collection [ElementAt]" action, with "expeccoVersion" as key:

			[[Datei:Rest_expecco_version_extractVersion.png\|600px\|New Test/Demo Setup]]

2018-04-23T17:59:00Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 17:59 Uhr
Zeile 96:		Zeile 96:

	[[Datei:Rest_expecco_version_run.png\|600px\|REST Output]]		[[Datei:Rest_expecco_version_run.png\|600px\|REST Output]]

			As you can see, the full response text (JSON encoded) is provided at the "responseText" pin,
			and the decoded object (an ordered dictionary) at the "responseObject" pin.
			The later contains a key-value pair for "expeccoVersion".
			To further extract individual fields, use the "Collection [ElementAt]" action, with "expeccoVersion" as key:

2018-04-23T17:55:10Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 17:55 Uhr
Zeile 89:		Zeile 89:
	[[Datei:Rest_expecco_version_schema.png\|600px\|REST Schema Editor]]		[[Datei:Rest_expecco_version_schema.png\|600px\|REST Schema Editor]]

	Finally try it in the "Test/Demo" page, providing the localhost's endPoint at the "__url__" input:		Finally try it in the "Test/Demo" page, providing the localhost's endPoint ("localhost:9090") at the "__url__" input:

	[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST Test/Demo]]		[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST Test/Demo]]

			Then, run it and take alook at the output pins:

			[[Datei:Rest_expecco_version_run.png\|600px\|REST Output]]

2018-04-23T17:53:35Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 17:53 Uhr
Zeile 91:		Zeile 91:
	Finally try it in the "Test/Demo" page, providing the localhost's endPoint at the "__url__" input:		Finally try it in the "Test/Demo" page, providing the localhost's endPoint at the "__url__" input:

	[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST ~~Schema Editor~~]]		[[Datei:Rest_expecco_version_testDemo.png\|600px\|REST Test/Demo]]

2018-04-23T17:51:16Z

Adding a PING-request Action

← Nächstältere Version		Version vom 23. April 2018, 17:51 Uhr
Zeile 85:		Zeile 85:

	Here, the "endPoint" field is left empty, so the action can be used with any service host.		Here, the "endPoint" field is left empty, so the action can be used with any service host.
	Then, navigate to the schema page, change the value for "__decode__" to "true" (because the expecco-REST service will deliver JSON encoded data) and freeze the "objectLocator" pin to the "/remote/ping", the object-locator for the ping service entry:		Then, navigate to the schema page, change the value for "__decode__" to "true" (because the expecco-REST service will deliver JSON encoded data) and freeze the "objectLocator" pin to the "remote/ping", the object-locator for the ping service entry:

	[[Datei:Rest_expecco_version_schema.png\|600px\|REST Schema Editor]]		[[Datei:Rest_expecco_version_schema.png\|600px\|REST Schema Editor]]