# Create Period(Appium2)

### Endpoint Information

* **URL**: \<your-gateway-url>/plan/{planId}/period
* **Method**: `POST`
* **Authentication**: Required (`Bearer Token`)

### Request Body

Manual

```
{
  "periodType": "MANUAL",
  "startDate": null,
  "endDate": null,
  "onceDate": null,
  "daysOfWeek": null,
  "repeatPeriod": null,
  "scheduled": false
}
```

ONCE

```
{
  "periodType": "ONCE",
  "startDate": null,
  "endDate": null,
  "onceDate": "2025-01-10T09:30:00.000Z",
  "daysOfWeek": null,
  "repeatPeriod": null,
  "scheduled": true
}
```

REPETITIVE

```
{
  "periodType": "REPETITIVE",
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-02-01T00:00:00.000Z",
  "onceDate": null,
  "daysOfWeek": null,
  "repeatPeriod": 1,
  "scheduled": true
}
```

| Parameter    | Type    | Description                                                                               |
| ------------ | ------- | ----------------------------------------------------------------------------------------- |
| periodType   | String  | Defines the scheduling type of the period                                                 |
| startDate    | Date    | Start date and time of the scheduled period.                                              |
| endDate      | Date    | End date and time of the scheduled period. Determines when the repetitive schedule stops. |
| onceDate     | Date    | Exact date and time used when the period type is ONCE.                                    |
| daysOfWeek   | String  | Comma-separated list of days. Used in weekly repetitive schedules.                        |
| repeatPeriod | Integer | Frequency of repetition                                                                   |
| scheduled    | boolean | Indicates whether scheduling is enabled for this period.                                  |

### Example Response

```
{
    "data": {
        "id": 631,
        "periodType": "MANUAL",
        "startDate": null,
        "endDate": null,
        "onceDate": null,
        "daysOfWeek": null,
        "repeatPeriod": null
    },
    "result": {
        "code": 0,
        "message": "success"
    }
}
```

| Parameter      | Type    | Description                                                                       |
| -------------- | ------- | --------------------------------------------------------------------------------- |
| data           | Object  | The payload of the response. In this case `null` since no extra data is returned. |
| result         | Object  | Contains details about the outcome of the operation.                              |
| result.code    | Integer | The result code (e.g., `0` indicates success).                                    |
| result.message | String  | A message describing the outcome (e.g., `"success"`).                             |

| HTTP Code | Error Message           | Description                                                                  |
| --------- | ----------------------- | ---------------------------------------------------------------------------- |
| 401       | `UNAUTHORIZED`          | The request lacks valid authentication credentials. Check your Bearer token. |
| `400`     | `INVALID_REQUEST`       | The request was malformed or contained errors.                               |
| `500`     | `INTERNAL_SERVER_ERROR` | An unexpected error occurred on the server side.                             |

### Example Request

```
curl --location '<your-gateway-url>/plan/{planId}/period' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <your_access_token>' \
--header 'content-type: application/json' \
--data '{
  "periodType": "MANUAL",
  "startDate": null,
  "endDate": null,
  "onceDate": null,
  "daysOfWeek": null,
  "repeatPeriod": null,
  "scheduled": false
}'
```


---

# 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/plan/create-period-appium2.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.