This article will guide you through creating a new TA schedule via BioStar 2 TA API.
In order to create a schedule via BioStar 2 TA API, you need to call the following API:
POST /schedules/schedule/create
[Body Parameters]
| Parameters | Type | Required | Description |
|---|---|---|---|
| name | String | Y | name of schedule |
| description | String | Y | description of schedule |
| rule | N | rule to be added to schedule | |
| :id | String | N | id of rule |
| :name | String | N | name of rule |
| start_datetime | String | Y | schedule START datetime in UTC using ISO-8601 format ex: 2024-01-01T00:00:00.000Z or 2024-01-01 (Time will be set to 00:00:00) |
| end_datetime | String | Y | schedule END datetime in UTC using ISO-8601 format ex: 2024-01-01T00:00:00.000Z or 2024-01-01 (Time will be set to 23:59:59) |
| holiday_list | Array | N | list of holiday_list to be added to schedule |
| :name | String | N | name of holiday_list |
| :id | String | N | id of holiday_list |
| schedule_template:id | String | Y | id of schedule_template to be added to schedule |
| user_list | Array | Y | list of users to be added to schedule |
| :id | String | Y | id of user |
[Postman Example of Request Body]
This example only includes the mandatory fields.
[Postman Example of Response]
After running the API successfully, you'll receive a 201 (Created) HTTP status code and a response body with the new schedule's ID.
You can also check the results of running the API on the BioStar 2 Web UI.
