Testinium
  • Testinium Cloud
    • GET STARTED
      • What is Testinium?
      • Go to Testinium
    • How to run tests in Testinium?
    • Testinium Cloud Navigation
  • LOGIN
    • Login
      • Log in to Testinium
      • Reset Password
  • DASHBOARD
    • Dashboard
  • USER PROFILE
    • User Profile
      • Account Information
  • PROJECTS
    • Projects
      • Create New Project
      • Summary
      • Scenarios
      • Plans
      • Advanced
      • Properties
  • SCENARIOS
    • Scenarios
      • Create Scenario
      • Edit Scenarios
      • Delete Scenarios
      • Create New Group
      • Sync Scenarios
  • PLANS
    • Plans
      • Create Plan
      • Edit Plans
      • Delete Plans
      • Report
      • Run Plan
      • Quick Run Plan
  • REPORTS
    • Reports
      • Test Execution(Auto)
      • Scheduled Reports(Periodically Scheduled)
        • Create New Periodically Reports
        • Edit Periodically Report
        • Delete Periodically Report
        • Periodically Report History
      • Smart Prioritization Report
  • AUTOMATED TEST
    • Automated Test
      • Test Code Generator(Web)
      • Test Code Generator(Android Web)
      • Test Code Generator(IOS Web)
      • Test Code Generator(Android App)
      • Test Code Generator(IOS App)
      • Operation Report
  • PLUGINS
    • Plugins
      • Jenkins
      • Automated Test
      • Jira
      • Slack
      • TestRail
  • API's
    • Auth
      • Login
    • Account
      • Delete Customer API
      • Get All Roles
      • Get Customer ID by Company ID
      • Get Package Price by Package, Period, and Currency
      • Get User Details by Customer ID and User ID
      • Get Customer Information
      • Get Last Subscribed Product Packages of Customer
      • Update User
      • Get Billings by Customer ID
      • Get Address Types
      • Get Phone Types
      • Get Countries
      • Get Live Testing Parallel Limit
      • Update Live Testing Parallel Limit
      • Update Repository Information
      • Get Users of a Customer
      • Get All Products
    • Project
      • Get All Projects
      • Get All Projects By ProjectID
      • Get All Projects By Company ID
      • Get All Active Projects
      • Create Mobile Project
      • Create Service Project
      • Create WEB Project
      • Create Project From Template
      • Upload Mobile App
      • Delete Mobile App
      • Get Framework Summary
      • Enable Project
      • Disable Project
      • Get Jira Settings By ProjectID
      • Update Project For Jira Issue Settings
      • Get TestRail Settings By ProjectID
      • Update Project TestRail Settings
      • Get Xray Settings By ProjectID
      • Update Xray Settings By ProjectID
      • Get Xray Project Key Activation Information
      • Delete Project
      • Get Branch List By ProjectID
      • Get Plugins
    • Plan
      • Get All Test Plans
      • Get Plan By Plan ID
      • Get All Parent Plans
      • Get All Plans By Project ID
      • Get Active Test Plans
      • Run Test Plan
      • Force Run Test Plan
      • Quick Run Test Plan
      • Check Test Plan Running Status
      • Create Test Plan
      • Update Test Plan
      • Delete Test Plan
      • Get Band Width Types
      • Get Maximum Execution Times
      • Get Browsers
      • Get All Desktop Environments
      • Get All Mobile Environments
      • Get Total Plan Count by Filter
      • Get Files of a Test Plan
    • Reports
      • Get All Test Executions By Plan ID
      • Get Test Execution By ID
      • Download Execution Report by ID
      • Get Test Results of Execution by Scenario ID
      • Get Detailed Test Result
      • Filter Test Executions
      • Get Total Test Execution Runtime
      • Get Test Results Per Day
      • Graph Prioritization
      • Graph Prioritization Scenario
      • Get Plans By Scheduled Reports
      • Create Scheduled Report
      • Get All Scheduled Reports
      • Get Scheduled Report by ID
      • Update Scheduled Report
      • Get Scheduled Report History
      • Delete Scheduled Report
      • Get Public Report Link
      • Get Automated Apps for a Company
      • Get Remote Test Results Detailed
      • Get Test Result Detailed
    • Scenario
      • Get All Scenarios
      • Get All Group Scenarios
      • Get Scenario By ID
      • Get Test Scenarios By Filter
      • Get Scenarios by Execution ID
      • Get Last Failed Scenarios of a Test Plan
      • Create Scenario
      • Create Group Scenario
      • Update Scenario
      • Delete Scenario
      • Delete Multiple Scenarios
      • Get Total Scenario Count by Filter
      • Get File List (Source Tree)
      • Get BDD Steps
      • Read Test Method List
  • RELEASE NOTES
    • Release Notes
      • Testinium-Cloud 2.13.8 Release Notes
      • Testinium-Cloud 2.13.6 Release Notes
      • Testinium-Cloud 2.13.5 Release Notes
      • Testinium-Cloud 2.13.4 Release Notes
      • Testinium-Cloud 2.13.3 Release Notes
      • Testinium-Cloud 2.13.2 Release Notes
      • Testinium-Cloud 2.13.1 Release Notes
      • Testinium-Cloud 2.13.0 Release Notes
      • Testinium-Cloud 2.12.4 Release Notes
Powered by GitBook
On this page
  • Endpoint Information
  • Request Parameters
  • Response
  • Response Fields
  • Error Codes
  • Example Request
  1. API's
  2. Plan

Get All Test Plans

This endpoint retrieves all test plans for the authenticated user's company, optionally filtering by project ID and active status. The user must have the PLAN_VIEW authority to access this endpoint.


Endpoint Information

  • URL: https://testinium.io/Testinium.RestApi/api/plans/lazy

  • Method: GET

  • Authentication: Required (Bearer Token)

  • Header: Required (current-company-id: <your_company_id>)


Request Parameters

Parameter
Type
Required
Default
Description

projectId

Long

No

null

The unique ID of the project to filter test plans.

active

Boolean

No

true

Whether to fetch only active test plans.


Response

The response is a list of test plans with detailed information.

{
        "id": 11695,
        "type": "SELENIUM",
        "project_id": 5876,
        "project_name": "InTicket Test Project",
        "company_id": 2760,
        "plan_name": "Emergency Warnings Test Plan",
        "scenarios": [
            70024,
            70026
        ],
        "alerts": [
            {
                "alert_type": "EMAIL",
                "alert_sending_status": "EVERY_TEST",
                "target": "atetestteam@acibadem.com",
                "plan_id": 11695,
                "enabled": true,
                "unsubscribe_link_eliminated": false
            }
        ],
        "enabled": true,
        "group_plan": false,
        "plan_parallel_test_limit": 1,
        "failed_test_retry_count": 1,
        "alerts_enabled_result": false,
        "project_enabled": true,
        "test_run_type": "CROSS",
        "created_at": "2021-09-13T05:57:43Z",
        "updated_at": "2022-07-18T14:32:32Z",
        "created_by": "acibadem",
        "updated_by": "onurhanozcan",
        "xray_enabled": false,
        "screen_shot_type": "YES",
        "video_enabled": true,
        "test_plan_java_parameters": [],
        "performance_data_enabled": false,
        "file_download_path": ""
    },
    {
        "id": 11706,
        "type": "APPIUM",
        "project_id": 5927,
        "project_name": "Patient Online Android Project",
        "company_id": 2760,
        "plan_name": "Measurements Test Plan",
        "scenarios": [
            70043
        ],
        "alerts": [],
        "enabled": true,
        "group_plan": false,
        "plan_parallel_test_limit": 10,
        "failed_test_retry_count": 0,
        "alerts_enabled_result": false,
        "project_enabled": true,
        "test_run_type": "CROSS",
        "created_at": "2021-09-13T10:49:32Z",
        "created_by": "acibadem",
        "updated_by": "acibadem",
        "xray_enabled": false,
        "screen_shot_type": "YES",
        "video_enabled": true,
        "test_plan_java_parameters": [],
        "clear_app_data": false,
        "uninstall_app_after_test": false
    },

Response Fields

Field
Type
Description

id

Long

Unique ID of the test plan.

type

String

The type of test plan (e.g., SELENIUM, APPIUM).

project_id

Long

ID of the associated project.

project_name

String

Name of the associated project.

company_id

Long

ID of the company that owns the test plan.

plan_name

String

Name of the test plan.

scenarios

Array

List of scenario IDs linked to the test plan.

alerts

Array

List of alerts associated with the test plan.

enabled

Boolean

Whether the test plan is enabled.

group_plan

Boolean

Whether the test plan is a group plan.

plan_parallel_test_limit

Integer

Maximum parallel tests allowed.

failed_test_retry_count

Integer

Number of retries for failed tests.

alerts_enabled_result

Boolean

Whether alerts are enabled for this plan.

project_enabled

Boolean

Whether the associated project is enabled.

test_run_type

String

The type of test execution (e.g., CROSS).

created_at

String

Timestamp of when the test plan was created.

updated_at

String

Timestamp of when the test plan was last updated.

created_by

String

Username of the creator of the test plan.

updated_by

String

Username of the last updater of the test plan.

xray_enabled

Boolean

Whether Xray integration is enabled.

screen_shot_type

String

Whether screenshots are taken (YES, NO).

video_enabled

Boolean

Whether video recording is enabled.

test_plan_java_parameters

Array

Java parameters used in the test plan.

performance_data_enabled

Boolean

Whether performance data collection is enabled.

file_download_path

String

File download path if applicable.

clear_app_data

Boolean

(For mobile tests) Whether app data is cleared.

uninstall_app_after_test

Boolean

(For mobile tests) Whether the app is uninstalled after the test.


Error Codes

HTTP Code
Error Message
Description

403

ACCESS_DENIED

User lacks PLAN_VIEW authority.

400

INVALID_REQUEST

The request was malformed or contained invalid parameters.

500

SYSTEM_INTERNAL_ERROR

An unexpected error occurred on the server side.


Example Request

curl --location --request GET 'https://testinium.io/Testinium.RestApi/api/plans/lazy?projectId=5876&active=true' \
--header 'Authorization: Bearer <your_access_token>' \
--header 'current-company-id: <your_company_id>'
PreviousPlanNextGet Plan By Plan ID

Last updated 3 months ago