Метод: GET
Authorization: Bearer Token
URL: https://tcl.twin24.ai/api/bot/v1/bots?11
Описание параметров метода:
| Параметр | Тип параметра | Обязательность | Значение по умолчанию | Описание |
|---|---|---|---|---|
| withoutCount | bool | нет | false | true – НЕ выводить поле "count" с количеством сценариев в ответ false – выводить поле "count" с количеством сценариев в ответ |
| withoutItems | bool | нет | false | true – НЕ выводить поле "items" со списком сценариев в ответ false – выводить поле "items" со списком сценариев в ответ |
| limit | int | нет | все сценарии | Ограничение количества данных, которые нужно получить |
| offset | int | нет | 0 | Смещение по позиции полученной информации |
| page | int | нет | 0 | Страница выдачи. (Используется, если limit < количества сценариев, чтобы перебирать выдачу постранично, где на каждой странице максимум "limit" элементов) |
| fields | string | нет | id, name, companyId, accessType, language, nlp, solver, critic, tuner, problemGenerator, viewDetails, createdAt, updatedAt | Список полей, которые нужно выдать в ответе по каждому сценарию (перечислять через запятую и без пробелов): id – идентификатор сценария/бота |
sort | string | нет | +createdAt,+updatedAt | Список полей для сортировки (перечислять через запятую и без пробелов, использовать знак "+" перед полем для сортировки по возрастанию, "-" – для сортировки по убыванию) |
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"count": 2,
"items": [
{
"id": "890251fb-d1ee-43e4-a68d-72a87c05b10f",
"name": "Welcome",
"companyId": 1758,
"accessType": "PRIVATE",
"language": "RU",
"nlp": "Twin\\Support\\Nlu\\RasaNaturalLanguageParser",
"solver": "Twin\\TwinBot\\Model\\Bot\\Solver\\Graph\\v1\\GraphSolver",
"critic": null,
"tuner": null,
"problemGenerator": null,
"viewDetails": [],
"createdAt": "2021-10-20 02:01:54.729507+00",
"updatedAt": "2021-10-20 02:01:54.729507+00"
},
{
"id": "a524a704-b2a4-4fc8-a89d-0c1a171fda6d",
"name": "09-06-2021",
"companyId": 1758,
"accessType": "PRIVATE",
"language": "RU",
"nlp": "Twin\\Support\\Nlu\\RasaNaturalLanguageParser",
"solver": "Twin\\TwinBot\\Model\\Bot\\Solver\\Graph\\v1\\GraphSolver",
"critic": null,
"tuner": null,
"problemGenerator": null,
"viewDetails": [],
"createdAt": "2021-10-20 02:01:54+00",
"updatedAt": "2021-10-20 02:11:04.136799+00"
}
]
} |
Описание полей ответа:
| Поле | Тип | Описание |
|---|---|---|
count | int | Количество найденных сценариев |
items | itemsInfo[ ] | Массив с информацией по каждому сценарию |
id | string | идентификатор сценария/бота |
name | string | название сценария/бота |
companyId | int | идентификатор компании |
accessType | string | ограничение прав доступа сценария |
language | string | используемый язык распознания |
nlp | string | ссылка на NLU |
solver | string | ссылка на модуль принятия решений |
critic | string | |
tuner | string | |
problemGenerator | string | |
viewDetails | viewDetailsInfo[ ] | |
createdAt | string | дата создания сценария/бота |
updatedAt | string | дата последнего обновления сценария/бота |
авыаыв