Plan
Run Test Plan
URL {gateway-url}/queue Method POST Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) If the run request is processed successfully, the endpoint returns HTTP 200 OK with an empty JSON object. This endpoint does not return response fields.
Rerun Test Plan
The endpoint allows the user to rerun specific scenarios of a test plan. URL {gateway-url}/queue/rerun Method POST Authentication Required ( Bearer Token ) This response indicates that the rerun request was accepted successfully.
Stop Test Plan
This endpoint creates stop requests for active test results under one or more test plans. For each given plan ID, the service finds active test results with one of the following statuses WAITING , PROCESSING , or RUNNING .
Stop Test Result
This endpoint creates stop requests for one or more test results. For each given test result ID, the service checks whether the result is active.
Get Plan Java Parameters
URL {gateway-url}/plan-java-parameters/plan/{planId} Method GET Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body. If the plan does not have Java parameters, the endpoint returns an empty list This endpoint retrieves Java parameters of the given test plan.
Create Plan Java Parameter
URL {gateway-url}/plan-java-parameters/plan/{planId} Method POST Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint replaces the Java parameters of the given test plan. Existing Java parameters for the plan are deleted first.
Get Period By Id
URL {gateway-url}/plan-periods/period/{periodId} Method GET Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body. This endpoint retrieves a period by periodId , not by planId .
Get Result Alert Status
URL {gateway-url}/alerts/status/type/result? executionStatusName={executionStatusName} Method GET Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body.
Get Execution Alert Status
URL {gateway-url}/alerts/status/type/execution Method GET Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body. EXECUTION STARTED represents alerts triggered at the beginning of each execution.
Delete Alert By Id
URL {gateway-url}/alerts/{id}/plan/{planId} Method DELETE Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body. If the delete operation is completed successfully, the endpoint returns HTTP 200 OK with an empty JSON object.
Get Alert By Plan Id
URL {gateway-url}/alerts/plan/{planId} Method GET Authentication Required ( Bearer Token ) Company Header Required ( X-Company-Id ) This endpoint does not require a request body. If no alert exists for the plan, the endpoint returns an empty list This endpoint retrieves alerts configured for the given test plan.
Create Alert
This endpoint creates an alert configuration for a test plan. Alerts can be created for execution start or execution completion events.
Update Plan (Appium2)
This endpoint updates an existing Appium2 test plan. Most fields are optional.
Get Plan Environment List
This endpoint returns the environment list assigned to a test plan. For Appium2 plans, the endpoint returns active DevicePark-style plan environments.
Create Plan Environment (Appium2)
This endpoint creates or updates the environment list of an Appium2 test plan. The request body contains the DevicePark environment definitions that should be assigned to the plan.
Create Plan Scenarios (Appium2)
This endpoint assigns scenarios to a test plan. The operation replaces the current scenario list of the plan with the scenario IDs provided in the request body.
Create Period (Appium2)
This endpoint creates or updates the period configuration of a test plan. If the plan does not have a period, a new period is created and assigned to the plan.
Get Plan By ID (Appium2)
This endpoint returns the details of a test plan by its ID. For Appium2 plans, the response contains plan configuration, project information, mobile app details, execution settings, and related metadata.
Get Appium2 Devices
This endpoint returns the DevicePark devices that can be used for Appium2 test plan environments. The response includes device identity, platform, version, operational status, session status, and availability information.
Create Test Plan(Appium2)
This endpoint creates a new test plan for an Appium2 project. The request must include the project ID, plan name, user ID, plan type, and test run type.
Get All Plans by User's Companies
The endpoint retrieves all test plans associated with a specific project that belong to the companies that the authenticated user is associated with. The user must provide the project identifier in the path.
Get Plans Of Scenario
The endpoint retrieves the plans associated with a specific scenario. It returns a list of plans based on the provided project and scenario information.
Get All Active Plans by Project ID
The endpoint retrieves all active test plans associated with a specific project identified by its ID. The authenticated user must belong to a company that is authorized to access the project.
Get Plan By ID
The endpoint retrieves a test plan based on the plan's name or ID. The test plan is returned as a PlanDTO object.
Get Plan By Project And Plan Name Or Id
The endpoint retrieves a test plan associated with a specific project based on the project's name or ID, and the plan's name or ID. The test plan is returned as a PlanDTO object.
Get Active Plan By ID
The endpoint retrieves an active test plan based on its ID. The response will return the plan as a PlanDTO object if the user has permission to access it.
Update Selected Android Mobile App for Test Plan
The endpoint allows users to update the selected Android mobile app for a specific test plan. The user must provide the test plan ID and the mobile app ID to be set.
Update Selected iOS Mobile App for Test Plan
The endpoint allows users to update the selected iOS mobile app for a specific test plan. The user must provide the test plan ID and the mobile app ID to be set.
Get All Plans By Project Name or ID
The endpoint retrieves all test plans associated with a specific project. The user must provide the project identifier in the path.