Testinium Enterprise
  • TESTINIUM ENTERPRISE
    • Testinium Enterprise Documentation
  • Login
    • User Login
    • Reset Password
  • Dashboard
    • Dashboard
    • User Profile
    • Company Details
  • System Settings
    • System Settings
      • Licence Information
        • Add New Licence Key
        • Edit Licence Key
        • Delete Licence Key
        • Update Public Key
      • General Test Plan Settings
      • System Properties
        • Creating New System Property
        • Edit Property
        • Delete Property
      • Selenium Hubs
        • Creating Selenium Hub
        • Edit Selenium Hub
        • Delete Selenium Hub
      • Role / Permission Management
        • Roles
          • Create New Role
          • Edit Role
          • Delete Role
        • Permission
          • Create New Permission
          • Edit Permission
          • Delete Permission
      • Browsers / Phones
        • Create New Phone/Browser
        • Edit Phone/Browser
        • Delete Browser/Phone
      • Test Environments
        • Create New Environment
        • Edit Enviroment
        • Delete Environment
      • Test Environment Status
      • Active Tests
      • Screen Resolutions
        • Create New Screen Resolution
        • Edit Screen Resolution
        • Delete Screen Resolution
      • Predefined Exceptions
        • Create Predefined Exception
        • Edit Predefined Exception
        • Delete Predefined Exception
      • Cloud Test Environment
      • Cloud Test Environments Groups
        • Create Cloud Environment Group
        • Edit Cloud Environment Group
        • Delete Cloud Environment Group
      • Notifications
      • Project Clone
      • Company’s Scheduled Plan
  • Companies
    • Companies
      • Create New Company
      • Edit Company
  • Users
    • Users
      • Create New User
      • Edit User
      • Delete User
      • Manage Roles
  • Projects
    • Projects
      • Create New Project
      • Edit Project
      • Delete Project
  • Plans
    • Plans
      • Create Plan
      • Edit Plan
      • Delete Plan
      • Test Report
      • Run Test Plan
      • Show Running Test Plan
      • Run with Tag
      • New Tag
  • Scenarios
    • Scenarios
      • Create New Scenarios
      • Create New Group
      • New Sub Scenario
      • Edit Scenario
      • Delete Scenario
      • Export Excel
  • BDD EDITOR
    • Create Concept File
    • Create Spec File
    • Create Feature File
  • REPORTS
    • Test Executions (Auto)
      • Test Result Reports
    • Test Execution(Remote)
    • Detailed Reports
      • Test Result Report
    • Instant Reports
    • Scheduled Report
      • Create New Periodically Reports
      • Edit Periodically Report
      • Delete Periodically Report
      • Report History
    • Graph Report
    • Execution Graph
    • Pass Rate Reports
    • Test Executions (Tag)
    • Test Result by Period
  • Plugins
    • Plugins
      • Jenkins
      • Azure Devops Board
      • Jira
      • Testinium Cloud
  • API's
    • Auth
      • Login
    • Project
      • Get All Projects
      • Get Project by ID or Name
      • Get Projects by Company ID
      • Get Active Project By ID
      • Get All Projects by User's Companies
      • Get All Companies
      • Create Project
      • Update Project
      • Upload File to Project
      • Delete Mobile App
    • Scenario
      • Get All Scenarios
      • Get Scenarios Of Plan
      • Get Scenario by Name or ID
      • Get Scenarios by User Company
      • Get Test Parameters
      • Create Scenario
      • Update Scenario
      • Update Test Parameters
    • Plan
      • Get All Plans
      • Get All Plans By Project Name or ID
      • Get All Plans by User's Companies
      • Get Plans Of Scenario
      • Get All Active Plans by Project ID
      • Get Plan By ID
      • Get Plan By Project And Plan Name Or Id
      • Get Active Plan By ID
      • Create Test Plan
      • Update Test Plan
      • Update Selected Android Mobile App for Test Plan
      • Update Selected iOS Mobile App for Test Plan
      • Run Test Plan
      • Run Test Plan with Company ID
      • Rerun Test Plan
      • Stop Test Plan
      • Check If Test Plan Is Running
    • Reports
      • Get Test Execution by ID
      • Get All Test Executions by Plan
      • Get All Test Executions by Plan and Page
      • Get Test Result by ID
      • List Test Results by Execution ID
      • List Test Results
  • RELEASE NOTES
    • Release Notes
      • Testinium-Enterprise 1.16.7 Release Notes
      • Testinium-Enterprise 1.16.6 Release Notes
      • Testinium-Enterprise 1.16.5 Release Notes
      • Testinium-Enterprise 1.16.4 Release Notes
      • Testinium-Enterprise 1.16.3 Release Notes
      • Testinium-Enterprise 1.16.2 Release Notes
      • Testinium-Enterprise 1.15.1 Release Notes
      • Testinium-Enterprise 1.15.0 Release Notes
      • Testinium 1.14.4 Release Notes​
      • Testinium 1.14.1 Release Notes
      • Testinium 1.14.0 Release Notes
      • Testinium 1.13.4 Release Notes
      • Testinium 1.13.0 – 1.13.3 Release Notes
  • Appium 2 Sample Projects
    • Appium 2 Sample Projects
      • Appium 2 Java
        • BaseTest
        • IOSTest And AndroidTest
        • Hook
      • Appium 2 Gauge
        • HookImp
        • pom.xml
        • StepImp
        • Spec File
        • Concept File
Powered by GitBook
On this page
  • Endpoint Information
  • Path Variables
  • Response Body
  • Error Codes
  • Example Request
  1. API's
  2. Plan

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.


Endpoint Information

  • URL: <custom-env-url>/Testinium.RestApi/api/plans/{planId}/active

  • Method: GET

  • Authentication: Requires Bearer Token


Path Variables

Parameter
Type
Required
Description

planId

Long

Yes

The ID of the test plan.


Response Body

Upon a successful request, the API returns the active test plan in JSON format.

{
    "id": 77,
    "project_id": 66,
    "company_id": 1,
    "plan_name": "wakeup",
    "group_plan": false,
    "description": "",
    "enabled": true,
    "plan_parallel_test_limit": 8,
    "scenarios": [
        666
    ],
    "period": {
        "period_type": "MANUAL",
        "days_of_week": "2,3,4,5,6,7,1",
        "repeat_period": 60
    },
    "alerts": [],
    "alerts_enabled": false,
    "failed_test_retry_count": 0,
    "screen_shot_type": "YES",
    "video_enabled": false,
    "environments": [
        {
            "id": 21
        }
    ],
    "clear_app_data": false,
    "fetch_app_files": [],
    "selected_android_mobile_app": {
        "id": 83,
        "mobile_app_name": "3.2.16__106_-4a968996-4595859751696432436.apk",
        "mobile_app_hash": "b4bf52f6eb3bc531f19de9537792cfdf",
        "operating_system": "ANDROID",
        "mobile_app_metadata": "{\"packageName\":\"com.gratis.android\",\"label\":\"Gratis\",\"icon\":\"res/mipmap-mdpi-v4/ic_launcher.webp\",\"versionName\":\"3.2.16\",\"versionCode\":106,\"minSdkVersion\":\"24\",\"targetSdkVersion\":\"34\",\"glEsVersion\":{\"major\":2,\"minor\":0,\"required\":false}}",
        "created_at": "2024-08-15 08:55:22"
    },
    "selected_ios_mobile_app": {
        "id": 82,
        "mobile_app_name": "Gratis-2a14af4e-1391709825629909183.ipa",
        "mobile_app_hash": "5e14f1af8f3053dbf6a4d97a63422617",
        "operating_system": "IOS",
        "mobile_app_metadata": "{\"bundleName\":\"Gratis\",\"bundleDisplayName\":\"Gratis\",\"bundleVersion\":\"3.2.11\",\"bundleMinOsVersion\":\"12.0\",\"bundleDevelopmentRegion\":\"tr\",\"bundleExecutable\":\"Gratis\",\"bundleIconFiles\":\"\",\"bundleInfoDictVersion\":\"6.0\",\"bundlePackageType\":\"APPL\",\"bundleMainStoryBoardFile\":\"Main\"}",
        "created_at": "2024-08-08 08:24:17"
    }
}
Field
Type
Description

id

integer

The unique ID of the test plan.

plan_name

string

The name of the test plan.

description

string

A brief description of the test plan.

project_id

integer

The ID of the associated project.

company_id

integer

The ID of the company associated with the test plan.

group_plan

boolean

Indicates if the test plan is a group plan.

enabled

boolean

Whether the test plan is enabled.

plan_parallel_test_limit

integer

The maximum limit of parallel tests allowed in the plan.

scenarios

array

List of scenario IDs associated with the plan.

period

object

The schedule and recurrence details of the plan.

alerts

array

List of alert details.

alerts_enabled

boolean

Indicates if alerts are enabled for this plan.

video_enabled

boolean

Whether video recording is enabled for the plan.

environments

array

List of environment IDs associated with the plan.

clear_app_data

boolean

Whether to clear app data for the test.

fetch_app_files

array

List of app files to be fetched for the test.


Error Codes

Possible error codes and their explanations during the operation:

HTTP Code
Error Message
Description

401

Unauthorized

Authorization failed. User is not logged in.

403

Forbidden

User does not have permission to access the specified plan.

404

Plan not found

The specified active plan was not found.

500

Internal Server Error

An unexpected error occurred on the server.


Example Request

curl --location '<custom-env-url>/Testinium.RestApi/api/plans/{planId}/active' \
--header 'Authorization: Bearer <your_access_token>'
PreviousGet Plan By Project And Plan Name Or IdNextCreate Test Plan

Last updated 2 months ago