# Create Scenario

The endpoint creates a new scenario for a specific project. A new scenario is saved based on the project information and scenario details provided by the user.

***

### Endpoint Information

* **URL**: `<custom-env-url>/Testinium.RestApi/api/projects/{projectNameOrId}/scenarios`
* **Method**: `POST`
* **Authentication**: `Bearer Token` is required
* **Content-Type**: `application/json`

***

### Path Variables

| Parameter         | Type     | Required | Description                    |
| ----------------- | -------- | -------- | ------------------------------ |
| `projectNameOrId` | `Object` | Yes      | The name or ID of the project. |

***

### Request Body

The request body must be a JSON object containing the details of the scenario.

```json
{
  "scenario_name": "DenemeSenaryo13",
  "description": "",
  "expected_result": "",
  "enabled": true,
  "execute_mode": "AUTOMATED",
  "source_file": "Android/MainPage.spec",
  "project_id": 580,
  "java_test_class": "Android/MainPage",
  "java_test_methods": "@Swipeeee"
}
```

| Field              | Type      | Required | Description                                                  |
| ------------------ | --------- | -------- | ------------------------------------------------------------ |
| `scenarioName`     | `String`  | Yes      | The name of the scenario.                                    |
| `description`      | `String`  | No       | A description of the scenario.                               |
| `expectedResult`   | `String`  | Yes      | The expected result of the scenario test.                    |
| `enabled`          | `Boolean` | Yes      | Indicates whether the scenario is enabled or not.            |
| `parentScenarioId` | `Long`    | No       | The ID of the parent scenario, if applicable.                |
| `executeMode`      | `String`  | Yes      | The execution mode (`AUTOMATED` or `MANUAL`).                |
| `sourceFile`       | `String`  | Yes      | The source file of the scenario (e.g., `loginTest.feature`). |
| `projectId`        | `Long`    | Yes      | The ID of the project to which the scenario belongs.         |
| `type`             | `String`  | Yes      | The type of the test (e.g., `SELENIUM`).                     |

***

### Response Body

Upon a successful request, the API returns a `ScenarioDTO` object containing the created scenario.

```json
{
    "id": 3132,
    "scenario_name": "DenemeSenaryo13",
    "description": "",
    "expected_result": "",
    "enabled": true,
    "execute_mode": "AUTOMATED",
    "source_file": "Android/MainPage.spec",
    "project_id": 580,
    "java_test_class": "Android/MainPage",
    "java_test_methods": "@Swipeeee"
}
```

| Field              | Type      | Description                                                  |
| ------------------ | --------- | ------------------------------------------------------------ |
| `id`               | `Long`    | The unique identifier of the created scenario.               |
| `scenario_name`    | `String`  | The name of the scenario.                                    |
| `description`      | `String`  | The description of the scenario.                             |
| `expectedResult`   | `String`  | The expected result of the scenario test.                    |
| `enabled`          | `Boolean` | Indicates whether the scenario is enabled or not.            |
| `parentScenarioId` | `Long`    | The ID of the parent scenario, if applicable.                |
| `executeMode`      | `String`  | The execution mode (`AUTOMATED` or `MANUAL`).                |
| `sourceFile`       | `String`  | The source file of the scenario (e.g., `loginTest.feature`). |
| `projectId`        | `Long`    | The ID of the project to which the scenario belongs.         |
| `type`             | `String`  | The type of the test (e.g., `SELENIUM`).                     |

***

### Error Codes

Possible error codes and their explanations during the operation:

| 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 project.      |
| `400`     | `Invalid Character`     | Invalid characters found in the source file.                  |
| `422`     | `Validation Failed`     | Required fields for scenario creation are missing or invalid. |
| `500`     | `Internal Server Error` | An unexpected error occurred on the server side.              |

***

### Example Request

```bash
curl --location '<custom-env-url>/Testinium.RestApi/api/projects/{projectNameOrId}/scenarios' \
--header 'Authorization: Bearer <your_access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "scenario_name": "DenemeSenaryo13",
        "description": "",
        "expected_result": "",
        "enabled": true,
        "execute_mode": "AUTOMATED",
        "source_file": "Android/MainPage.spec",
        "project_id": 580,
        "java_test_class": "Android/MainPage",
        "java_test_methods": "@Swipeeee"
    }'
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://testinium.gitbook.io/testinium-enterprise/apis/enterprise-2.0/scenario/create-scenario.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.