The Start Execution endpoint allows you to automate the execution of a model run.
POST request, you can enter parameter values to control the configuration of a model run, for example, which suite of snippets to run. You must specify the:
model_idfor an exploratory run, which is useful when you're building a model.
test_case_idfor a fully-configured model. If you start a run with only these two parameters, the model runs without connecting to any Eggplant Functional scripts and only generates a path through the model.
If you want to connect to an Eggplant Functional suite, you must use the agent to establish that connection, and give values for the parameters in the
POST -> http://localhost:8000/execution_service/api/v1/executions
You can also explore the Start Execution endpoint in Swagger:
To execute a model run, you must send a value for at least one of these parameters:
|enumeration||For an execution run, the value is always |
|string||UUID of the model to use for an exploratory or test case run.||Yes|
|object||Agent that is used for the model run.||No. If |
| ||string||ID of the agent connection to use.||No|
| ||boolean||Whether the agent is hosted or on the local machine.||No|
|integer||ID of the test case to execute for a test case run.||No|
|string||Name of the script to use for a script-based run.||No|
|object||Details of the test assets to use for test execution.||No. If |
| ||string||ID of the asset version to use.||No|
| ||string||Path of the suite to use on the connected agent.||No|
|object||Details of the SUT to use.||No|
| ||string||ID of the SUT.||No|
| ||array of strings||Criteria or tag of the SUT to lock. You can use this instead of the ||No|
|integer||For a rerun, this is the test case ID of the original model run.||No|
|integer||For internal use only.||No|
|Successful response||Execution started.|
|Bad request||Required parameters were not sent.|
|Unauthorized||The access token was not valid.|
|Access denied||Server denies access from the resource.|
|Validation error||Incorrect parameters were sent.|
|RabbitMQ is not available||Request cannot be completed because the message service is unavailable.|
Response Body JSON
Successful response – Status 200 returns the ID of the model execution that has started.