datasource update

Author: wulff007

ru/api/datasource-v2.md

@@ -16,7 +16,7 @@ description: Документация Tabbled платформы | Источн
 
 **Параметры ответа (200 OK)**
 
-* success (bool, required) - успешный запрос
+* statusCode (int, required) - успешность запроса,
 * item (DataSourceConfigDto, required) - параметры источника данных
 
 
@@ -26,7 +26,7 @@ description: Документация Tabbled платформы | Источн
 
 **Параметры ответа (200 OK)**
 
-* success (bool, required) - успешный запрос
+* statusCode (int, required) - успешность запроса,
 * items (DataSourceConfigDto[], required) - список источников данных
 
 
@@ -41,7 +41,7 @@ description: Документация Tabbled платформы | Источн
 
 **Параметры ответа (200 OK) - json object**: 
 
-* success (bool, required) - успешность запроса,
+* statusCode (int, required) - успешность запроса,
 * errors (Error[], optional, если success = false) - список возникших ошибок,
 * data (object, optional) - данные по созданному источнику данных 
   * id (string, required) - идентификатор созданного источника данных
@@ -59,7 +59,7 @@ description: Документация Tabbled платформы | Источн
 
 **Параметры ответа** (200 OK):
 
-* success (bool, required) - успешность запроса,
+* statusCode (int, required) - успешность запроса,
 * errors (Error[], optional, если success = false) - список возникших ошибок,
 * data (object, optional)
     * id (string, required) - идентификатор измененного источника данных
@@ -77,7 +77,7 @@ description: Документация Tabbled платформы | Источн
 
 **Параметры ответа** (200 OK):
 
-* success (bool, required) - успешность запроса,
+* statusCode (int, required) - успешность запроса,
 * errors (Error[], optional, если success = false) - список возникших ошибок,
 * data (object, optional)
     * id (string, required) - идентификатор измененного источника данных
@@ -102,15 +102,60 @@ description: Документация Tabbled платформы | Источн
 * route (string[], optional) - фильтр по пути записей, работает для источника с isTree = true
 * parentId (string, optional) - фильтр по родительскому элементу
 
-
 **Параметры тела ответа**
 
-* success (bool, required) - успешность запроса,
+* statusCode (int, required) - успешность запроса,
 * items (object[], optional) - список данных
   * ... все поля или указанные поля в параметре `fields`
 * errors (Error[], optional, если success = false) - список возникших ошибок,
 * count (int, required) - кол-во записей в выборке
+* totals (object, optional) - агрегированные значения полей переданных в запросе agg
+  * [field] (number, required) - значение агрегации по полю по всем данным их запроса
+
+### Получение итоговых значений данных
+
+Используется для отображения в колонках таблиц в подвале
+
+Метод: POST /v2/datasource/:alias/data/totals
+
+**Параметры тела запроса**
+
+* filter (FilterItemInterface[], optional) - фильтры
+* filterBy (string, optional) - фильтр с sql синтакисом, имеет приоритет над filter
+* query (string, optional) - поисковый запрос, если указаны фильтры, то с учетом фильтров
+* parentId (string, optional) - фильтр по родительскому элементу
+* agg (object[], optional) - агрегировать значения по полям
+    * field (string, required) - поле для агрегации
+    * func (string:enum, required) - функция, доступны значения
+        * none - не агрегировать
+        * sum - сумма всех значений
+        * avg - среднее значение
+        * min - минимальное значение
+        * max - максимальное значение
+
+**Параметры тела ответа**
+
+* statusCode (int, required) - успешность запроса,
+* totals (object, optional) - агрегированные значения полей переданных в запросе agg
+    * [field] (number, required) - значение агрегации по полю по всем данным их запроса
 
+### Экспорт данных в формате csv
+
+Используется для выгрузки данных по указанным колонкм, филльтрации и сортировки.
+Работает только для плоской структуры данных `isTree = false`
+
+Метод: POST /v2/datasource/:alias/data/export
+
+**Параметры тела запроса**
+
+* filter (FilterItemInterface[], optional) - фильтры
+* filterBy (string, optional) - фильтр с sql синтакисом, имеет приоритет над filter
+* query (string, optional) - поисковый запрос, если указаны фильтры, то с учетом фильтров
+
+**Параметры тела ответа**
+
+* statusCode (int, required) - успешность запроса,
+* file (string:base64, required) - файл закодированный в строку base64
 
 ### Получение записи по идентификатору
 
@@ -123,10 +168,59 @@ description: Документация Tabbled платформы | Источн
 
 Параметры тела ответа
 
-* success (bool, required) - успешность запроса,
+* statusCode (int, required) - успешность запроса,
 * item (object, required) - данные записи
   * ... все поля записи или только указанные поля в запросе
 
+### Добавить или обновить записи
+
+Метод: PUT /v2/datasource/:alias/data
+
+Принимает массив записей, которые должны буть добавлены или обновлены в источнике данных. 
+Если ид не передан или не существует в бд, будет добавлен новый.
+
+Работа с данными доступна только для типа источника данных internal-db
+
+Если в одной из записей ошибка, то все записи не будут обработаны.
+
+Параметры:
+* :alias - алиас источника данных
+
+Параметры запроса
+
+* items (object[], required, 1..100) - записи для добавления или обновления. Для существующей записи, не переданные поля будут иметь прежние значения, т.е. перезапишутся только переданные. Максимум 100 записей в одном запросе.
+  * id (string, optional) - если передан и существует в бд, то будет обновлен в бд
+  * [DataSourceField.alias] (any, optional) - значения параметры по алиасу поля
+* returnItems (bool, optional, default false) - если true, то в ответе будет возвращен массив добавленных/обновленных записей
+
+Параметры ответ
+
+* statusCode (int, required) - успешность запроса,
+* items (object[], optional) - список данных, если returnItems=true
+    * ... все поля записи включая системные
+* errors (Error[], optional, если success = false) - список возникших ошибок,
+
+
+### Удалить записи
+
+Метод: DELETE /v2/datasource/:alias/data
+
+Метод удаляет 
+
+Параметры:
+* :alias - алиас источника данных
+
+Параметры запроса
+
+* ids (string[], optional) - идентификаторы записей
+* where (string, optional) - sql like запрос удаления данных по условию
+* soft (bool, optional, default true) - мягкое удаление, если true, то ставится пометка удаления, запись в бд остается, но в списке больше не выводиться 
+
+Параметры ответа:
+
+* statusCode (int, required) - успешность запроса,
+* errors (Error[], optional, если success = false) - список возникших ошибок
+
 ### Индексировать данные
 
 Индексирует данные для быстрого поиска и фильтрации списка данных. Для индексации создается задача которая выполняется отдельным процессом, в ответ получаем `taskId` статус которого можно узнать в отдельном методе. 
@@ -162,6 +256,7 @@ Body параметры:
 
 Параметры ответа: 
 
+* statusCode (int, required) - успешность запроса,
 * items (object, required) - данные записи
     * id (string, required) - ид истории изменения
     * version - версия
@@ -200,32 +295,41 @@ Body параметры:
 ## DataSourceConfigDto
 * title (string, required) - название,
 * type (string:enum, required) - тип источника, может принимать значения:
-    * internal `deprecated` - внутрениий источник данных, данные храняться в единой таблице в виде json объекта,
-    * internal-db `в разработке` - внутрениий источник данных, умеет управлять полями таблиц, данные храняться в отдельной таблице
-    * custom - для особых случаев работы с данными, исполняется на стороне клинета, поэтому для обработки больших данных лучше не использовать
+    * internal - внутрениий источник данных, данные храняться в единой таблице в виде json объекта,
+    * custom - для особых случаев работы с данными, исполняется на стороне клинета, для обработки больших данных лучше не использовать
     * restapi `в разработке` - загружает данные через метод апи стороннего сервиса
     * sql `в разработке` - позволяет получать данные с помощью SQL запроса,
 * alias (string, required) - уникальный алиас или псевдоним источника данных,
 * fields (Field[], required) - поля
 * readonly (bool, optional, default false) - только для чтения,
 * isTree (bool, optional, default false) - древовидный источник данных,
-* keyFields (string[], optional, default [id]) - ключевые поля, доступно только для типа `internal-db`, если установлено, то можно загружать данные по ключу через метод `POST /v2/datasource/:alias/data/by-keys`
-* eventHandlers (EventHandler[], optional, default []) - подпись на события изменения в данных
 * permissions (object, required) - разрешения
-    * can{`Action`} (string:enum) - возможные значения
+    * [Action] (string:enum) - возможные значения
+      * type: 
         * all - все могут
         * roles - могут перечисленные роли, указанные в `can{Action}Roles`
         * nobody - никто
-    * can{`Action`}Roles - роли, обязательно для `can{Action} = roles`
+      * roles (string[], optional) - опеределенные роли, которым разрешено, в случае если тип указан roles
 
 ## Field
 
 Настройка полей источника данных
 
 Параметры
 
-* alias
-* type
+* alias (string, required) - алиас поля
+* type (FieldType, required) - тип поля
+* title (string, required) - заголовок поля
+* searchable (boolean, optional, default true) - поле для полтотекстового поиска, по умолчанию false, доступна установка в true только для типа string
+* filterable (boolean, optional, default true) - фильтруемое поле, по умолчанию true для полей с типом number, enum, link, bool, time, date, datetime
+* sortable (boolean, optional, default true) - сортируемое поле, по умолчанию true для number, string
+* isMultiple (bool, optional) - множественные значения, доступно только для link, enum, image, file
+* defaultValue (string, optional) - значение по умолчанию
+* datasourceReference (string, optional) - алиас источника данных, обязательно для типа link и table. Для link будет являться источником данных для отображения в выпадающем списке. Для table будет служить определением вложенной структуры данных, ссылатся может только на источник данных с типом field
+* autoincrement (boolean, optional, default false) - счетчик, только для типа number
+* isNullable (boolean, optional, default true) - значение может принимать null
+* precision (boolean, optional) - точность числового значения
+* enumValues (enum[], optional) - значения перечисления, обязательно для типа enum 
 
 
 ## FieldType
@@ -257,23 +361,22 @@ Body параметры:
 * Remove - удалить строку
 
 Пример:
+
 ```json
 {
   ...
   "permissions": {
-    "canAdd": "roles",
-    "canEdit": "roles",
-    "canRemove": "roles",
-    "canAddRoles": [
-      "managers"
-    ],
-    "canEditRoles": [
-      "managers"
-    ],
-    "canRemoveRoles": [
-      "managers"
-    ]
+    "canAdd": {
+      "type": "roles",
+      "roles": [
+        "managers"
+      ]
+    },
+    "canSelect": {
+      "type": "any" 
+    }
   }
+}
 ```
 
 ## EventHandler