Экспорт набора данных

Данный метод позволяет экспортировать набор данных в файл. Значение, которое возвращается в теле ответа, должно быть использовано для загрузки целевого файла через GET-метод по следующему URL:

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/download?uid=1

где 1 представляет собой значение, которое должно быть возвращено с сервера (см. далее).

URL

/dataset/export

Метод

POST

Диапазон

project_view

Тип ответа

async

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

<отсутствуют>

Тело запроса (application/json)

{
  "wrapperGuid": "b00ea397-c668-4d93-be7e-b0889dfafa37",
  "type": "csv",
  "fileName": "C:\\export.csv"
}

где

Имя Тип Описание

wrapperGuid

строка

GUID враппера.

type

строка

Тип файла, в который вы хотите экспортировать ваши данные ("csv", "xls", "html", "xml", "xlsx", "json").

fileName

строка

Имя файла.

Необязательные параметры тела запроса могут быть следующими:

Имя Тип Описание Комментарий

rowIDs

число массив

ID строк.

Если массив пустой, все строки будут экспортированы.

columnIndexes

число массив

Индексы колонок.

Если массив пустой, все колонки будут экспортированы.

Query parameters

JSON-объект

Список параметров экспорта.

Список параметров экспорта представлен в следующей таблице:

Имя Тип Описание Комментарий

abortConvError

булевый

Флаг, указывающий на остановку выполнения узла при любых ошибках преобразования символов.

ansiEncoding

число

ANSI-кодировка.

appendData

булевый

Флаг, проверяющий существование внешнего файла с указанным именем и в той же директории.

columnFormat

строка

Формат представления колонок.

createSchemaFile

булевый

Флаг, определяющий создание файла-схемы в той же папке, что и CSV-файл, но с расширением SCH; файл-схема будет содержать информацию о настройках колонок.

Если "true", будут возвращены два значения (см. пример ответа).

datePartsDisplayOrder

строка

Порядок хранения значений месяцев, дней и года.

decimalPoint

строка

Символ, который должен представлять десятичную точку числа.

delimiter

строка

Символ, который должен представлять разделитель строк на колонки.

emptyValue

строка

Если значение булевой, число или целочисленной колонки нулевое, указанное в этом поле значение вносится в файл; нулевые значения обычно хранятся как пустые значения внутри CSV-файлов.

emptyAsNull

булевый

Флаг, включающий хранение пустых значений как "null" при экспорте в JSON.

enableCellFormatting

булевый

Флаг, включающий форматирование ячеек.

Используется при экспорте в XLS и XLSX.

enableHighlighting

булевый

Флаг, включающий подсветку.

Используется при экспорте в XLS и XLSX.

enclosingSymbol

строка

Символы, которые используются для заключения строк в CSV-файле; обычно это " (символ кавычки).

endOfLines

строка

Символ конца строки: "r\n\" для DOS-формата, "\n" для формата Unix/MAC.

fileEncoding

число

Кодировка файла.

hourFormat

строка

Формат указания времени, где "12" – это формат AM/PM, а "24" – 24-часовой формат.

integerIDPrefix

строка

Префикс числового идентификатора, который используется при работе с колонками, содержащими категориальный тип данных; обычно префикс отсутствует или в качестве префикса используется знак ~.

Если параметр не пустой, то целочисленные ID будут сохранены в кавычках (чтобы соответствовать требованиям к типам данных в JSON (при экспорте в JSON)).

noValue

строка

Строковое представление ложных значений, которые будут сохранены, если useAlphabeticBoolNames имеет значение "true"; типичными значениями являются "false", "no" или "0".

outputColumnHeaders

булевый

Флаг, указывающий, сохранять ли названия колонок в экспортируемом файле.

precision

число

Количество цифр после десятичного знака в экспортируемом файле.

saveFormatting

булевый

Флаг, указывающий, сохранять ли мета-данные.

schemaDelimiter

строка

Разделитель для файла-схемы, если параметр createSchemaFile равен "true". Вы также можете задать произвольный разделитель. Если значение параметра schemaSeparator равно 5, параметр schemaDelimiter будет интерпретироваться как число и использоваться в качестве разделителя. Во всех остальных случаях принимается значение параметра schemaDelimiter. Параметр schemaDelimiter всегда должен указываться вместе с параметром schemaSeparator.

schemaSeparator

строка

Разделитель для файла-схемы, если параметр createSchemaFile равен "true", где "0" – запятая, "1" – точка с запятой, "2" – пробел, "3" – табуляция, "4" – разделитель, определяемый пользователем, "5" – символ Юникода u+…​ (также задается пользователем). Параметр schemaSeparator всегда должен указываться вместе с параметром schemaDelimiter.

separator

строка

Символ границы между колонками, где "0" – запятая, "1" – точка с запятой, "2" – пробел, "3" – табуляция. Вы можете задать свой собственный разделитель.

showMilliseconds

булевый

Флаг, определяющий, показывать ли миллисекунды.

showTimeDate

строка

Указывает, какая часть значения даты и времени должна быть сохранена, где "1" – дата, "2" – время, "3" – дата и время.

showTrailingZeros

булевый

Флаг, указывающий, нужно ли сохранять замыкающие нули после десятичного знака.

thousandsDelimiter

строка

Символ, который должен представлять разделитель тысяч.

timeDateDisplayOrder

строка

Порядок хранения значений даты и времени: "DT" (дата и время) или "TD" (время и дата).

useAlphabeticBoolNames

булевый

Указывает, следует ли заменять логические значения их строковыми эквивалентами.

usePrecisionInScientificFormat

булевый

Флаг, указывающий на необходимость сохранения точности измерений.

writeBOM

булевый

Флаг, указывающий, следует ли записывать маркер последовательности байтов Юникода.

yesValue

строка

Строковое представление истинных значений, которые будут сохранены, если useAlphabeticBoolNames имеет значение "true"; типичными значениями являются "true", "yes" или "1".

Пример URL-запроса

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/dataset/export

Тело ответа (application/json)

[
  "1"
]

где

Имя Тип Описание

uid

строка

ID файла для экспорта.

Примеры ответов

Код Тело ответа и описание

200

Успех.

[
  "1"
]

200

Успех (если параметр createSchemaFile равен true).

[
  "1",
  "2"
]

403

Ошибка – Ошибка авторизации.

{
  "error": {
    "code": 403,
    "title": "Authorization Required",
    "message": "You are not logged in to PolyAnalyst Server."
  }
}

500

Ошибка – Враппер не найден.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "The wrapper with the given GUID is not found on the server"
  }
}