Elastic Execution Grid API

Elastic Execution Grid offers REST API services. If you prefer to steer Elastic Execution Grid via API instead of its graphical user interface, you can do so.

What you can do with the Elastic Execution Grid API

You can perform the following tasks with the Elastic Execution Grid API:

 

If you create tests in Tricentis Tosca

If you create tests in any other framework

Check Agent Agent machines are the machines on which you execute your tests. They host the Agent Service and the Runners. The Agent Service receives the Flow from the server and directs it to the required Runner. The Runner actually executes the test. status

Yes

Yes

Upload test artifacts

No*

Yes

Create Flows A Flow determines the sequence of your tests. It consists of other Flows, which in turn consist of Units. out of test artifacts

No*

Yes

Trigger the execution of your Flows

It depends**

Yes

Get test status

Yes

Yes

Get results

Yes

Yes

* You design your tests in Tricentis Tosca.

** You trigger the execution in Tricentis Tosca. After that, you can find out the Flow ID via the API. This Flow ID allows you to rerun tests via Elastic Execution Grid API. However, if you integrated via AOS because you want your test results back in Tricentis Tosca, you must trigger the execution in Tricentis Tosca. If you trigger the execution via Elastic Execution Grid, results are in Elastic Execution Grid only.

Steer Elastic Execution Grid via API

To steer Elastic Execution Grid via API, follow the steps below:

  1. Make sure you have authorization.

  2. Upload your test artifacts. For information on requests and responses, see the Artifacts – v1 definitions.

  1. Create Flows out of your test artifacts. Flows determine the sequence of your tests. You can also add execution context to Flows, for instance Characteristics Characteristics help you define which Elastic Execution Grid Agent should execute which tests. When you set up an Agent, you define its Characteristics: one for every application that's relevant to your tests. When you push tests to Elastic Execution Grid, you define which Characteristics you need to run these tests. Elastic Execution Grid forwards tests only to Agents with matching Characteristics. Only Agents that have all Characteristics you specify can execute the tests. or timeout specifications.

    For information on requests and responses, see the Flows – v1 definitions.

  2. Ensure that your Agents are up and running. For information on requests and responses, see the Agents – v1 definitions.

  3. Trigger or cancel your test runs.

    • For information on requests and responses, see the Flow Execution – v1 definitions.

    • For information on how Elastic Execution Grid cancels executions, click here.

  4. Check the progress of your Flows and get results. For information on requests and responses, see the Status – v1 definitions.