10.Подготовка данных (публичные данные)

Набор данных#

POST Создание нового набора данных SQL#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/{engineName}/table/sql Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса Параметры пути и описание

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

PUT Обновление набора данных SQL#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: PUT {{API_PATH_BI_V3}}/{engineName}/table/sql Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса Параметры пути и описание

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

GET Получение информации о наборе данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: PUT {{API_PATH_BI_V3}}/table/info?tables=["41d9b0ba4241438dba34a708361e9aae"] Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

POST Добавление набора данных базы данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/{engineName}/table/db Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса Параметры пути и описание

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

DEL Удаление набора данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: DEL {{API_PATH_BI_V3}}/table?tables=["41d9b0ba4241438dba34a708361e9aae"] Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

PUT Изменение псевдонима набора данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: PUT {{API_PATH_BI_V3}}/table/name Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)#

GET Анализ происхождения набора данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: GET {{API_PATH_BI_V3}}/table/usage?tables=["9ff9f5ee388e43fb9639476fa3521dbd"] Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (201)

POST Добавление серверного набора данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/{engineName}/table/dataset Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса Параметры пути и описание

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

Извлечение обновления#

GET Запуск глобального обновления#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: GET {{API_PATH_BI_V3}}/spider/update/all Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (201)

POST Запуск обновления служебного пакета#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/spider/update/pack Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

POST Запуск обновления набора данных#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/spider/update/table Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

GET Запрос и обновление статуса задачи обновления#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: GET {{API_PATH_BI_V3}}/spider/update/instance/info?taskInstanceIds=["86a93cb8-781e-4d4b-8a58-f5deb9e4e8c1"] Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

POST Просмотр истории выполнения задач обновления BI#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/spider/update/monitor/task/history/query Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

POST Просмотр текущего состояния задач обновления BI#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_BI_V3}}/spider/update/monitor/task/running/query Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

Папки#

GET Получение всех папок#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_BI_V3}}/conf/groups

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса: данных образца ответов пока нет.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "data": [
        {
            "id" : "9b539b7d398641b389c9c33ee5fcabed" , //folder id
            "name" : "folder" , //folder name
            "createBy" : "admin" , //creator name
            "packs": [
                {
                    "id" : "102a8a2183cf4304ae566abedca05c60" , //subfolder id
                    "name" : "folder" , //subfolder name
                    "createBy" : "admin" , //creator name
                    "packs" : [] // List of folders contained in the subfolder
                }
            ] //Folder list contained in the folder
        }
    ] //Return data, business packages and grouping trees
}

Failed (201)#

POST Добавление папки#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_BI_V3}}/conf/pack

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "parentPack" : "[]",
        "packName" : "Test Folder"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "packId": "11632ff43fa74a22b5c744bae06a1e86",
                "packName": "Test Folder"
            }
        }
    ]
}

Failed (404)#

PUT Переименование папки#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_BI_V3}}/conf/pack/name

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "pack" : "11632ff43fa74a22b5c744bae06a1e86",
        "newPackName" : "New Test Folder"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": true
        }
    ]
}

Failed (404)#

DEL Удаление папки#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_BI_V3}}/conf/pack?packs=["ee5466019bbb420995655f2e0c559f15"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "data": [
        {
            "status" : true , //status success-true failure-false
            "data" : true //The operation is successful
        }
    ] //Batch return results
}

Failed (404)#

GET Получение информации, связанной с папкой#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_BI_V3}}/conf/pack/info?packs=["11632ff43fa74a22b5c744bae06a1e86"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "11632ff43fa74a22b5c744bae06a1e86",
                "name": "New Test Folder",
                "owner": "cfeddc85-59b0-46c1-8667-f44a63cfbdbf",
                "createBy": "admin.kirill",
                "tables": [],
                "tableList": []
            }
        }
    ]
}

Failed (404)#