Rerun Test Plan

The endpoint allows the user to rerun specific scenarios from the last executed results of a test plan.

Endpoint Information

Request Body

{
  "planId": 704,
  "userId": 1,
  "scenarioEnvironmentPairs": [
    {
      "scenarioId": 4267,
      "environmentId": 2001
    },
    {
      "scenarioId": 4312,
      "environmentId": 2002
    }
  ]
}

Request Body Parameters

Parameter
Type
Required
Description

planId

Long

Yes

The unique ID of the test plan to execute.

userId

Long

Yes

The unique ID of the user who runs plan.

scenarioId

Long

No

The unique ID of the test scenario to run.

environmentId

Long

No

The unique ID of the environment in which the scenario should be executed.

Response

This response indicates that the operation was completed successfully, with no additional data returned.

{
    "data": null,
    "result": {
        "code": 0,
        "message": "success"
    }
}

Response Fields

Parameter
Type
Description

data

Object

The payload of the response. In this case null since no extra data is returned.

result

Object

Contains details about the outcome of the operation.

result.code

Integer

The result code (e.g., 0 indicates success).

result.message

String

A message describing the outcome (e.g., "success").

Error Codes

HTTP Code
Error Message
Description

401

UNAUTHORIZED

The request lacks valid authentication credentials. Check your Bearer token.

400

INVALID_REQUEST

The request was malformed or contained errors.

500

INTERNAL_SERVER_ERROR

An unexpected error occurred on the server side.

Application Error Codes

Code

1000

Full authentication is required to access this resource

10000

Plan with id {planId} not found!

10002

User with id {userId} not found!

Example Request

curl --location '{gateway-url}/queue/rerun' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>\
--data '{
  "planId": {planId},
  "userId": {userId},
  "scenarioEnvironmentPairs": [
    {
      "scenarioId": {scenarioId},
      "environmentId": {environmentId}
    }
  ]
}'

Last updated