Экспорт проекта

Операция позволяет пользователям экспортировать проект с сервера.

Статус операции возвращается в заголовке location ответа. См. здесь для получения дополнительной информации.

URL

/project/export

Метод

POST

Диапазон

project_view

Тип ответа

async

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

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

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

{
  "fileName": "D:/PA 6.5 projects/Taxonomy.pa6",
  "fileFormat": "pa6",
  "ids": [
    "2ce2c135-c800-415b-9ed3-3920a3858ad4"
  ],
  "compressionLevel": 5,
  "multi": false,
  "keepSliceStatistics": false,
  "keepBackups": false,
  "keepMacrosAndVars": false,
  "overwriteExisting": false
}

где

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

fileName

строка

Имя проекта.

fileFormat

строка

Формат проекта.

ids

массив строк

Идентификаторы проектов.

compressionLevel

число

Уровень сжатия.

multi

булевый

Флаг, указывающий, что экспортируется больше 1 проекта.

keepSliceStatistics

булевый

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

keepBackups

булевый

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

keepMacrosAndVars

булевый

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

overwriteExisting

булевый

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

Параметры fileName, fileFormat и ids являются обязательными. Все другие параметры опциональны.

Параметр fileName не может быть пустым. В противном случае возвращается ошибка 400.

Параметр должен содержать абсолютный путь к проекту, например, D:/PA 6.5 projects/Taxonomy.

Параметр fileFormat должен содержать одно из следующих значений: pa6, ps6, paar6, psar6 или pagridar6.

Параметр compressionLevel содержит число, которое используется для определения уровня сжатия проекта:

  • 0 – Без сжатия

  • 1 – Скоростной

  • 3 – Быстрый

  • 5 – Нормальный

  • 7 – Максимальный

  • 9 – Ультра

По умолчанию значение параметра compressionLevel равно 5.

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

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

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

<отсутствует>

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

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

202

Запрос был принят к обработке. Тело ответа пустое.

400

Ошибка – Неверное имя файла

{
  "error": {
    "code": 400,
    "title": "",
    "message": "The file name must not contain the following characters: \ / : * ? " < > |"
  }
}

400

Ошибка – Невалидное значение параметра fileFormat

{
  "error": {
    "code": 400,
    "title": "",
    "message": "Unknown file format (only 'pa6', 'ps6', 'paar6', 'psar6' and 'pagridar6' are allowed)"
  }
}

500

Ошибка – Ошибка доступа к файлу

{
  "error": {
    code": 500,
    title": "",
    message": "Error accessing file - relative file names are not allowed. Probably corresponding alias or network name is missing in the server configuration."
  }
}