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

Get Projects by Company ID

This endpoint retrieves a list of projects associated with a specific company. It ensures that the authenticated user has access to the company before returning the project list.


Endpoint Information

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

  • Method: GET

  • Authentication: Bearer Token is required


Path Parameters

Parameter
Type
Required
Description

companyId

Long

Yes

The unique identifier of the company


Response Body

On success, 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"
        }
    ]
  },
  {
    "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": []
  },
  {
    "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

Possible error codes and their explanations during the operation:

HTTP Code
Error Message
Description

204

No Content

The user does not have access to any projects associated with the company.

401

Unauthorized

Authorization failed. The user is not logged in.

403

Forbidden

The user does not have permission to access the company.

404

Company not found

The specified company was not found.


Example Requests

curl --location '<custom-env-url>/Testinium.RestApi/api/projects/projectsByCompany/{companyId}' \
--header 'Authorization: <your_access_token>'
PreviousGet Project by ID or NameNextGet Active Project By ID

Last updated 2 months ago