Содержание

Серверная загрузка данных

API отправки

api type: POST
/api/v3/dataLoader/send
//headers//
Authorization: Bearer YOUR_TOKEN
Content-Type: application/x-www-form-urlencoded
//body//
body : string(данные для отправки)
dataSetId : string(id dataSet)
 
//return// возвращает id лога
Корректная отправка
{
    "status": 200,
    "message": "5d2*******d0c80",
    "code": 0
}
Токен не корректен
{
    "status": 400,
    "message": "Authorization error",
    "code": 0
}
Не отправлен токен авторизации
{
    "status": 403,
    "message": "Not logged in",
    "code": 0
}

Примеры данных по загрузке

Описание формата загрузки и выгрузки

API получения логов

Запрос логов осуществляется по ID, который был получен после отправки данных для загрузки. «userId»/«dataLoaderId» Указывается id либо пользователя если загрузка идёт напрямую пользователем, либо если загрузка идёт через dataLoader

id = logId
format = json
/api/v3/logs/get
{
    "_id": string, //Уникальный идентификатор
 
    "createTime": unixtime, //Время загрузки данный в систему
    "startUploadTime": unixtime, //Время начала обработки данных
    "endUploadTime": unixtime, //Время окончания обработки данных
 
    "totalCount": int, //Общее количество объектов
    "successCount": int, //Количество успешно загруженных объектов
    "errorCount": int, //Количество неуспешно загруженных объектов
 
    "status": "wait" | "progress" | "error" | "success"
    "message": string,
 
    "customer": {
        "id": string,
        "source": "user" | "dataLoader",
        "name": string
    }
 
    "dataSetId": string,
    "uniqueField": string | null,
 
    filesFromInput: string[], //Загруженные файлы
    filesFromStorage: string[], //Пути к загруженными файлам на сервере
 
    "objectErrors" : Array<{
     "id" : string,
     "message" : string,
     "code" : int
    }>
}

Создание модуля загрузки

1. Блок «Модуль загрузки» отвечает за создание нового модуля с указанием имени `/api/dataLoader/create`.

2. Блок «Дополнительные конфигурации». Данный блок содержит настройки места отправки «Хранилище данных\DataSet» и «Тип отправляемых данных». Можно выбрать «Устройства\location», «Статичные\Static». Формат данных для «Static» Описание формата загрузки и выгрузки , формат данных для location формат location.

3. Блоке «Список токенов» содержит в себе список доступных для заданного DataLoader-а токенов. При необходимости можно запросить новый токен указав имя для него.

4. Блок «Способ отправки данных» содержит форму запроса к API.

Коды ошибок

Ошибки загурзки