Batch Executions

Run an ad-hoc batch

Runs a one-time batch of the tests selected by labels and returns the ID of the started batch execution.

post/v2/batch-executions

Request

  • Base URL: https://app.aiva.works (the document declares no server; this is the origin it was published from)
  • URL: https://app.aiva.works/v2/batch-executions
  • Auth: API key in header X-API-KEY

Request body

namestring nullable

Name of the batch execution.

labelsstring[] required

Tests carrying all of these labels run. At least one label is required.

maxNumberOfAgentsinteger nullable

Maximum number of agents running tests in parallel. Omit to run the tests sequentially.

globalVariableOverridesobject nullable

Variable overrides applied to every test. Values must not be empty.

variableOverridesPerTestobject nullable

Variable overrides per test, keyed by test ID. They win over the global overrides.

gatewayIdstring guid nullable

ID of the gateway to run on. Omit to use each test's default gateway (the public internet if it has none).

Example request

{
  "name": "CI Batch",
  "labels": [
    "smoke",
    "regression"
  ],
  "maxNumberOfAgents": 3,
  "globalVariableOverrides": {
    "username": "testuser",
    "password": "testpass"
  },
  "variableOverridesPerTest": {
    "123e4567-e89b-12d3-a456-426614174000": {
      "expectedText": "Success",
      "username": "otheruser"
    }
  },
  "gatewayId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Response

Batch execution started

executionIdstring guid

ID of the started batch execution.

Changes

No recorded changes to this operation across all 1 revision of this API.