6.Управление наборами данных сервера

GET Получение всех серверных наборов данных#

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

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

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

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

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array	Возвращаемые данные
data.datasetType	file	да	String	Тип набора данных
data.datasetName	region managers	да	String	Название набора данных
data.datasetId	null	да	Null	ID набора данных (по умолчанию null)
data.datasetData	см. JSON-ответ выше	да	String	Подробная конфигурация набора данных (структура различается для разных типов наборов данных)
data.urls	reportlets/excel/People.xls	да	Array	URL-адреса набора данных (по умолчанию null)

Failed (404)#

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

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

Статус интерфейса: Опубликован URL интерфейса: DEL {{API_PATH_V3}}/dataset?datasets=["Test Dataset 1"] Способ аутентификации: Аутентификация не требуется

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

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

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
datasets	["Test Dataset 1"]	да	String	Наименования наборов данных, которые требуется удалить

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

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array
data.status	true	да	Boolean	Статус

Failed (404)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
errorCode	500	да	String	Код ошибки
errorMsg	errorMsg	да	String	Сообщение ошибки

POST Предварительный просмотр существующего серверного набора данных#

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

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/dataset/preview?rowCount=200 Content-Type: application/json Способ аутентификации: Аутентификация не требуется

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

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

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
rowCount	200	да	String	Максимальное количество предварительно просматриваемых строк

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

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
datasetName	sql-data-01	да	String	Название набора данных
parameters		да	Array	Параметры

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

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
data		да	Array
data.columns		да	Array	Коллекция столбцов
data.columns.dataSetValue	null	да	Null	Зарезервированное поле, по умолчанию пустое
data.columns.columnName	name	да	String	Название столбца
data.columns.columnValue	0	да	Integer	Значение столбца
data.columns.columnType	String	да	String	Тип данных столбца
data.rows		да	Array	Коллекция строк
data.rows.0	A	да	String	Значение каждой строки

Failed (404)#

Встроенные типы наборов данных#

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

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

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

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

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

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
name	sql-data-01	да	String	Название подключения данных
type	sql	да	String	Тип подключения данных
connectionName	Data Connections	да	String	Название обновляемого подключения
staticSQL	select 1	да	String	SQL-запрос
parameter		да	Array	Параметры
parameter.type	String	да	String	Тип поля параметра
parameter.name	id	да	String	Название поля
parameter.value	123	да	String	Значение поля

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

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data	success	да	String
data.status	true	да	Boolean	Статус

Failed (404)#

PUT Обновление набора данных встроенного типа#

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

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

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

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

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
name	sql-data-01	да	String	Название подключения данных
type	sql	да	String	Тип подключения данных
connectionName	Data Connections	да	String	Название обновляемого подключения
staticSQL	select 2	да	String	SQL-запрос
parameter		да	Array	Параметры
parameter.type	String	да	String	Тип подключения данных
parameter.name	id	да	String	Название подключения данных
parameter.value	123	да	String	Значение поля

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

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	success	да	String	Статус