Get Project by ID or Name

9 min

The endpoint enables authenticated users to retrieve detailed information about a project by specifying either its unique ID or name.

Endpoint Information

URL: <custom-env-url>/Testinium.RestApi/api/projects/{projectNameOrId}

Method: GET

Authentication: Requires Bearer Token

Content-Type: application/json

Request Headers

Header	Value	Description
Authorization	Bearer {access_token}	The access token obtained after login.
Accept	application/json	The type of content expected in the response.

Response Body

The API returns the following JSON structure for Appium project:

{
    "id": 77,
    "project_name": "AppiumJava",
    "description": "",
    "enabled": true,
    "repository_path": "appiumjava",
    "test_framework": "APPIUM",
    "test_file_type": "APPIUM_JAVA",
    "test_runner_tool": "MAVEN",
    "mobile_apps": [
        {
            "id": 58,
            "mobile_app_name": "Gratis-68c16a02-8181239309953606241.ipa",
            "mobile_app_hash": "046696ec4d2e7443f348fee4b49b4a2c",
            "operating_system": "IOS",
            "mobile_app_metadata": "{\"bundleName\":\"Gratis\",\"bundleDisplayName\":\"Gratis\",\"bundleVersion\":\"3.3.0\",\"bundleMinOsVersion\":\"12.0\",\"bundleDevelopmentRegion\":\"tr\",\"bundleExecutable\":\"Gratis\",\"bundleIconFiles\":\"\",\"bundleInfoDictVersion\":\"6.0\",\"bundlePackageType\":\"APPL\",\"bundleMainStoryBoardFile\":\"Main\"}",
            "created_at": "2024-11-28 10:59:00"
        },
        {
            "id": 57,
            "mobile_app_name": "3.2.39__130_-83f575df-b7266d12-ae6c7c43-401562538376308185.apk",
            "mobile_app_hash": "177f1b975b8f99e8006dd8bf88686f6e",
            "operating_system": "ANDROID",
            "mobile_app_metadata": "{\"packageName\":\"com.gratis.android\",\"label\":\"Gratis\",\"icon\":\"res/d2.webp\",\"versionName\":\"3.2.39\",\"versionCode\":130,\"minSdkVersion\":\"24\",\"targetSdkVersion\":\"34\",\"glEsVersion\":{\"major\":2,\"minor\":0,\"required\":false}}",
            "created_at": "2024-11-28 10:58:07"
        }
    ]
}

The API returns the following JSON structure for Service project:

  {
    "id": 89,
    "project_name": "KarateService",
    "description": "",
    "enabled": true,
    "repository_path": "karateservice",
    "test_framework": "SERVICE",
    "test_file_type": "SERVICE_KARATE",
    "test_runner_tool": "MAVEN",
    "mobile_apps": []
  }

The API returns the following JSON structure for Selenium project:

  {
    "project_name": "otomasyon",
    "description": "",
    "enabled": true,
    "repository_path": "otomasyon",
    "test_framework": "SELENIUM",
    "test_file_type": "SELENIUM_GAUGE",
    "test_runner_tool": "MAVEN",
    "mobile_apps": []
  }

Field	Type	Description
id	integer	The unique identifier of the project.
project_name	string	The name of the project.
description	string	A brief description of the project.
enabled	boolean	Indicates if the project is active or inactive.
repository_path	string	The path to the repository where the project is stored.
test_framework	string	The testing framework used in the project (e.g., APPIUM).
test_file_type	string	The type of test files in the project (e.g., APPIUM_JAVA).
test_runner_tool	string	The tool used to execute tests (e.g., MAVEN).

Error Codes

HTTP Code	Error Message	Description
404	Project Not Found	No project with the given ID or name exists.
403	Access Denied	The user does not have permission to access this project.
401	Unauthorized	Invalid or missing authentication credentials.
500	Internal Server Error	An unexpected error occurred on the server.

Example Request

curl --location '<custom-env-url>/Testinium.RestApi/api/projects/{projectNameOrId}' \
--header 'Authorization: <your_access_token>'