Skip to content

Commit f34b502

Browse files
committed
datasource api v2
1 parent f3e037d commit f34b502

File tree

1 file changed

+55
-6
lines changed

1 file changed

+55
-6
lines changed

Diff for: ru/api/datasource-v2.md

+55-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Конфигурация
44

5-
### Получение одного по алиасу
5+
### Получение настроек источника данных по алиасу
66

77
Метод: GET /v2/datasource/:alias
88

@@ -15,7 +15,7 @@
1515
* item (DataSourceConfigDto, required) - параметры источника данных
1616

1717

18-
### Получение списка
18+
### Получение списка источников данных
1919

2020
Метод: GET /v2/datasource
2121

@@ -25,7 +25,7 @@
2525
* items (DataSourceConfigDto[], required) - список источников данных
2626

2727

28-
### Создание
28+
### Создание источника данных
2929
**Метод**: POST /v2/datasource
3030

3131
Создает новый источник данных по указанным настройкам
@@ -38,10 +38,10 @@
3838

3939
* success (bool, required) - успешность запроса,
4040
* errors (Error[], optional, если success = false) - список возникших ошибок,
41-
* data (object, optional)
41+
* data (object, optional) - данные по созданному источнику данных
4242
* id (string, required) - идентификатор созданного источника данных
4343

44-
### Изменение
44+
### Изменение источника данных по алиасу
4545

4646
Перезаписывает настройки по алиасу
4747

@@ -59,7 +59,7 @@
5959
* data (object, optional)
6060
* id (string, required) - идентификатор измененного источника данных
6161

62-
### Обновление параметров настроек
62+
### Обновление параметров настроек по алиасу
6363

6464
Обновляет по алиасу настройки которые были переданы, те которые не переданы оставляет в исходном виде
6565

@@ -107,6 +107,55 @@
107107
* count (int, required) - кол-во записей в выборке
108108

109109

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+
110159

111160

112161
# Структура объектов

0 commit comments

Comments
 (0)