QUqualgent
missions

Request runs for test cases

Changed on

Request runs for one or more test cases against an app build. This is the same flow as the Run button in the QualGent dashboard: the request is recorded as a submission, each test case is dispatched for testing, and results are reviewed by QualGent before they are published to you.

**App build:**
- `app_file_id` is optional. If omitted, your organization's latest uploaded app is used.
- If you have no app and `app_install_source` is not `store_listing`, this returns `404`.

**One open request at a time:**
- An organization can have one open request. While one is open this returns `409`
  with `code: "run_in_progress"` and the open request in `open_run`.
- Send `replace_open: true` to cancel and remove the open request and start this one.

**Partial failures:**
- A test case that cannot be submitted is listed in `failures`; the others still go ahead.
  The response is `200` either way, so check `failed`.

**Returns:**
- `submission_id` to follow progress with `GET /v1/missions/submissions?submission_id=...`

**Retries:**
- If this returns `504`, the request may still have been created. Check
  `GET /v1/missions/submissions` before sending it again.
post/v1/missions/submit

Request

Headers

x-api-keystring

Request body

test_case_idsstring[] required

IDs of the test cases to run. Duplicates are ignored.

app_file_idstring nullable

ID of the app build to test, as returned by POST /v1/apps/upload. Defaults to your organization's latest uploaded app. Not needed when app_install_source is 'store_listing'.

app_install_source'uploaded_app' | 'store_listing' nullable

How the build is installed. Defaults to 'uploaded_app'.

varsobject nullable

Values for the test case's declared variables. Only accepted when exactly one test case is requested.

replace_openboolean nullable

An organization has one open request at a time. Set to true to cancel and remove the open request and start this one; otherwise a 409 is returned while one is open.

Example request

{
  "test_case_ids": [
    "660e8400-e29b-41d4-a716-446655440000"
  ],
  "app_file_id": "550e8400-e29b-41d4-a716-446655440000",
  "app_install_source": "uploaded_app",
  "vars": {
    "branch": "feature/login-fix"
  }
}

Response

Request submitted

submittedinteger required

Number of test cases submitted

failedinteger required

Number of test cases that could not be submitted

submission_idstring nullable

ID of the request. Pass it to GET /v1/missions/submissions to follow progress.

Example response

{
  "submitted": 2,
  "submission_id": "7b0e8400-e29b-41d4-a716-446655440000"
}

Changes