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
  • Query Parameters
  • Request Body
  • Response
  • Error Codes
  • Example Request
  1. API's
  2. Project

Get All Projects By ProjectID

This endpoint retrieves the project associated with the user's current company. Users must have the PROJECT_VIEW authority to access this endpoint.


Endpoint Information

  • URL: https://testinium.io/Testinium.RestApi/api/projects/{projectid}

  • Method: GET

  • Authentication: Required (Bearer Token)


Query Parameters

Parameter
Type
Required
Description

email

String

No

The email address of the user to filter projects. If provided, it must match the authenticated user's email.


Request Body

No request body is required. The email parameter can be passed as a query parameter.


Response

The response contains a list of projects, including details such as the project name, test configurations, and other metadata.

Mobile Project Response

[
    {
    "id": 390,
    "project_name": "project1",
    "enabled": true,
    "types": [
        "IOS"
    ],
    "repository_path": "project1",
    "test_framework": "APPIUM",
    "test_file_type": "APPIUM_GAUGE",
    "test_runner_tool": "MAVEN",
    "created_at": "2023-02-15T08:28:00Z",
    "updated_at": "2023-02-16T10:16:56Z",
    "created_by": "user",
    "updated_by": "user",
    "branch_name": "refs/heads/master",
    "testrail_enabled": false,
    "jira_enabled": false,
    "xray_enabled": false,
    "ios_mobile_app": "iosapp.ipa",
    "ios_app_hash": "02059ea989ebbb0a3c85aef4053c1b3b",
    "ios_meta": {
        "bundle_name": "Bundle",
        "bundle_display_name": "bundle_display_name",
        "bundle_version": "123",
        "bundle_min_os_version": "11.0",
        "bundle_development_region": "de",
        "bundle_executable": "Bundle",
        "bundle_icon_files": "",
        "bundle_info_dict_version": "6.0",
        "bundle_package_type": "APPL",
        "bundle_main_story_board_file": ""
    }
    }
]

WEB Project Response

[
        {
        "id": 1025,
        "project_name": "web project",
        "enabled": true,
        "types": [
            "WEB"
        ],
        "repository_path": "web-project",
        "test_framework": "SELENIUM",
        "test_file_type": "SELENIUM_GAUGE",
        "test_runner_tool": "MAVEN",
        "created_at": "2023-02-09T16:51:04Z",
        "updated_at": "2023-03-07T11:07:22Z",
        "created_by": "mehmetaksahin",
        "updated_by": "mehmetaksahin",
        "branch_name": "master",
        "testrail_enabled": false,
        "jira_enabled": false,
        "xray_enabled": false
    }
]

Service Project Response

[
    {
        "id": 1405,
        "project_name": "karateprojesi",
        "enabled": true,
        "types": [
            "SERVICE"
        ],
        "repository_path": "karateprojesi",
        "test_framework": "SERVICE",
        "test_file_type": "KARATE",
        "test_runner_tool": "MAVEN",
        "created_at": "2024-11-30T13:22:57Z",
        "updated_at": "2024-12-01T04:55:28Z",
        "created_by": "ali_veli",
        "updated_by": "ali_veli",
        "branch_name": "main",
        "testrail_enabled": false,
        "jira_enabled": true,
        "xray_enabled": false
    }
]

Response Fields

Field
Type
Description

id

Long

The unique ID of the project.

project_name

String

The name of the project.

enabled

Boolean

Indicates whether the project is enabled.

types

Array

List of supported test types (e.g., ANDROID, IOS, WEB, SERVICE).

repository_path

String

The repository path of the project.

test_framework

String

The test framework used (e.g., APPIUM, SELENIUM, SERVICE).

test_file_type

String

The type of test file used (e.g., APPIUM_GAUGE, SELENIUM_GAUGE, KARATE).

test_runner_tool

String

The test runner tool used (e.g., MAVEN).

created_at

String

The date and time when the project was created in ISO 8601 format.

updated_at

String

The date and time when the project was last updated in ISO 8601 format.

created_by

String

The username of the user who created the project.

updated_by

String

The username of the user who last updated the project.

branch_name

String

The Git branch name associated with the project.

testrail_enabled

Boolean

Indicates whether the project is connected to TestRail.

jira_enabled

Boolean

Indicates whether the project is connected to Jira.

xray_enabled

Boolean

Indicates whether the project is connected to Xray.

ios_mobile_app

String

The name of the iOS mobile application associated with the project.

android_mobile_app

String

The name of the Android mobile application associated with the project.

ios_app_hash

String

The hash of the iOS application file.

android_app_hash

String

The hash of the Android application file.

apk_meta

Object

Metadata information about the Android application.

ios_meta

Object

Metadata information about the iOS application.

Error Codes

HTTP Code
Error Message
Description

400

PROJECT_NOT_FOUND

No project found with the given ID.

401

UNAUTHORIZED_ACCESS

User authentication failed or token is missing.

403

ACCESS_DENIED

User lacks PROJECT_VIEW authority.

500

INTERNAL_SERVER_ERROR

An unexpected error occurred on the server side.


Example Request

curl --location --request GET "https://testinium.io/Testinium.RestApi/api/projects/{projectid}" \
--header 'Authorization: Bearer <your_access_token>'
PreviousGet All ProjectsNextGet All Projects By Company ID

Last updated 3 months ago