Run a suite

Table of Contents

Request

URL

/api/v1/default/suites/{suiteId}/execute

Verb

GET

URL-Parameters

Following are the parameters used in the URL or the QueryString showed by a placeholder with curly brackets. Replace the full parameter with the actual value including the curly brackets.

ParameterDescription
suiteIdThe ID of the suite that should be run. This value can be found in the browsers URL when opening a suite in the BiG EVAL frontend.

Header

ParameterDescription
AuthorizationThe Access-Token as explained in Authentication.

Body

not needed

Response

{
    "status": "QUEUED",
    "jobId": "123123",
}
ElementDescription
statusReturns the status of the job. Normally this is the value QUEUED. Otherwise the request returns an HTTP error code.
jobIdReturns the ID of the asynchronous job that was started.

Example: PowerShell

# The base-url of the BiG EVAL API and instance.
$bigevalUrl = "https://mybigevalserver/"
$baseUrl = $bigevalUrl+"api/v1/default/"

# The ID of the suite to execute.
$suiteId = 1

# Note that you need to request the AccessToken first. We do not show that in this example.
$accessToken = "123123123"

# Execute the suite.
$executeResult = Invoke-RestMethod -Uri ($baseUrl + "suites/" + $suiteId + "/execute") -Headers @{"Authorization"="Bearer $accessToken"}