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

Get Scenario by Name or ID

The endpoint retrieves a specific test scenario by its name or ID for the authenticated user. It returns a ScenarioDTO object.


Endpoint Information

  • URL: <custom-env-url>/Testinium.RestApi/api/scenarios/{scenarioNameOrId}

  • Method: GET

  • Authentication: Bearer Token is required

  • Content-Type: application/json


Path Variables

Parameter
Type
Required
Description

scenarioNameOrId

Object

Yes

The name or ID of the scenario to retrieve.


Response Body

Upon a successful request, the API returns a test scenario in JSON format.

{
    "id": 406,
    "scenario_name": "scenario1",
    "description": "",
    "expected_result": "",
    "enabled": true,
    "execute_mode": "AUTOMATED",
    "source_file": "com/example/ScenarioTests.java",
    "project_id": 61,
    "java_test_class": "com.example.ScenarioTests",
    "java_test_methods": "sendBigVideo"
}
Field
Type
Description

id

integer

The unique ID of the test scenario

scenario_name

string

The name of the test scenario

description

string

A brief description of the test scenario

expected_result

string

The expected outcome of the test scenario

enabled

boolean

Indicates if the scenario is active

execute_mode

string

Defines whether the scenario is AUTOMATED or MANUAL

source_file

string

The file path containing the test scenario

project_id

integer

The ID of the project associated with the test scenario

java_test_class

string

The fully qualified name of the Java test class

java_test_methods

string

The specific Java method(s) within the test class to execute

createdBy

string

The user who created the scenario


Error Codes

HTTP Code
Error Message
Description

401

Unauthorized

Authorization failed. The user is not logged in.

403

Forbidden

The user does not have permission to access the scenario.

404

Scenario not found

The specified scenario was not found.

500

Internal Server Error

An unexpected error occurred on the server side.


Example Request

curl --location '<custom-env-url>/Testinium.RestApi/api/scenarios/{scenarioNameOrId}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <your_access_token>'
PreviousGet Scenarios Of PlanNextGet Scenarios by User Company

Last updated 2 months ago