|
2 | 2 |
|
3 | 3 | ## Конфигурация
|
4 | 4 |
|
5 |
| -### Получение одного по алиасу |
| 5 | +### Получение настроек источника данных по алиасу |
6 | 6 |
|
7 | 7 | Метод: GET /v2/datasource/:alias
|
8 | 8 |
|
|
15 | 15 | * item (DataSourceConfigDto, required) - параметры источника данных
|
16 | 16 |
|
17 | 17 |
|
18 |
| -### Получение списка |
| 18 | +### Получение списка источников данных |
19 | 19 |
|
20 | 20 | Метод: GET /v2/datasource
|
21 | 21 |
|
|
25 | 25 | * items (DataSourceConfigDto[], required) - список источников данных
|
26 | 26 |
|
27 | 27 |
|
28 |
| -### Создание |
| 28 | +### Создание источника данных |
29 | 29 | **Метод**: POST /v2/datasource
|
30 | 30 |
|
31 | 31 | Создает новый источник данных по указанным настройкам
|
|
38 | 38 |
|
39 | 39 | * success (bool, required) - успешность запроса,
|
40 | 40 | * errors (Error[], optional, если success = false) - список возникших ошибок,
|
41 |
| -* data (object, optional) |
| 41 | +* data (object, optional) - данные по созданному источнику данных |
42 | 42 | * id (string, required) - идентификатор созданного источника данных
|
43 | 43 |
|
44 |
| -### Изменение |
| 44 | +### Изменение источника данных по алиасу |
45 | 45 |
|
46 | 46 | Перезаписывает настройки по алиасу
|
47 | 47 |
|
|
59 | 59 | * data (object, optional)
|
60 | 60 | * id (string, required) - идентификатор измененного источника данных
|
61 | 61 |
|
62 |
| -### Обновление параметров настроек |
| 62 | +### Обновление параметров настроек по алиасу |
63 | 63 |
|
64 | 64 | Обновляет по алиасу настройки которые были переданы, те которые не переданы оставляет в исходном виде
|
65 | 65 |
|
|
107 | 107 | * count (int, required) - кол-во записей в выборке
|
108 | 108 |
|
109 | 109 |
|
| 110 | +### Получение записи по идентификатору |
| 111 | + |
| 112 | +Метод: GET /v2/datasource/:alias/data/:itemId |
| 113 | + |
| 114 | +Параметры: |
| 115 | +* :alias - алиас источника данных |
| 116 | +* :itemId - идентификатор записи |
| 117 | +* fields - список полей, которые необходимо включить, если не указан, то все поля, включая системные |
| 118 | + |
| 119 | +Параметры тела ответа |
| 120 | + |
| 121 | +* success (bool, required) - успешность запроса, |
| 122 | +* item (object, required) - данные записи |
| 123 | + * ... все поля записи или только указанные поля в запросе |
| 124 | + |
| 125 | +### Получение список изменений записи по идентификатору записи |
| 126 | + |
| 127 | +Метод: GET /v2/datasource/:alias/data/:itemId/revisions |
| 128 | + |
| 129 | +Параметры запроса: |
| 130 | +* :alias - алиас источника данных |
| 131 | +* :itemId - идентификатор записи |
| 132 | + |
| 133 | +Параметры ответа: |
| 134 | + |
| 135 | +* success (bool, required) - успешность запроса, |
| 136 | +* items (object, required) - данные записи |
| 137 | + * id (string, required) - ид истории изменения |
| 138 | + * version - версия |
| 139 | + * createdBy (string, required) - ид пользователя внесшего изменения |
| 140 | + * createdAt (timestamp, required) - дата и время внесения изменения |
| 141 | + |
| 142 | + |
| 143 | +### Получение изменения записи по идентификатору записи и ид изменения |
| 144 | + |
| 145 | +Метод: GET /v2/datasource/:alias/data/:itemId/revisions/:revId |
| 146 | + |
| 147 | +Параметры запроса: |
| 148 | +* :alias - алиас источника данных |
| 149 | +* :itemId - идентификатор записи |
| 150 | +* :revId - идентификатор изменения |
| 151 | + |
| 152 | +Параметры ответа: |
| 153 | + |
| 154 | +* success (bool, required) - успешность запроса, |
| 155 | +* item (object, required) - все данные записи истории изменения |
| 156 | +* revisionId - идентификатор изменения |
| 157 | +* version - версия |
| 158 | + |
110 | 159 |
|
111 | 160 |
|
112 | 161 | # Структура объектов
|
|
0 commit comments