Get Active Test Plans

9 min

This endpoint retrieves active test plans based on the provided company ID and optional filters such as project ID. The user must have the PLAN_VIEW authority to access this endpoint.

Endpoint Details

URL: https://gateway.testinium.io/plan/active

Method: GET

Authentication: Required (Bearer Token)

Query Parameters

Name	Type	Required	Description
companyId	Long	Yes	The unique ID of the company for which active test plans are to be retrieved.
projectId	Long	No	The unique ID of the project to filter active test plans.
pageable	Pageable	No	Pagination information (page number, size) for retrieving results.

Example Response

{
    "data": {
        "content": [
            {
                "id": 1659,
                "planName": "Ber-Mobil-Gratis",
                "projectName": "BER Mobil Deneme"
            },
            {
                "id": 1672,
                "planName": "cloudReport",
                "projectName": "cloudtesti"
            }
        ],
        "page": {
            "size": 10,
            "number": 0,
            "totalElements": 2,
            "totalPages": 1
        }
    },
    "result": {
        "code": 0,
        "message": "success"
    }
}

Response Fields

Field	Type	Description
id	Long	The unique ID of the test plan.
projectName	String	The name of the associated project.
planName	String	The name of the test plan.

Error Codes

401
400	One or more required parameters are missing or invalid.
500	An unexpected error occurred.

Full authentication is required to access this resource

Example Request

curl --location --request GET 'https://gateway.testinium.io/plan/active?companyId=<companyId>&projectId=<projectId>&size=10&page=0' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <your_access_token>'