Импорт проекта

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

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

URL

/project/import

Метод

POST

Диапазон

project_edit

Тип ответа

async

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

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

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

{
  "fileName": "C:/New folder/Project.pa6",
  "folderPath": "",
  "conflictResolveMethod": "ChangeExistingId",
  "spaceId": "95306631-c680-43df-8850-9501b6752f23"
}

Параметр fileName используется для указания пути к файлу проекта.

Параметр folderPath обозначает папку, в которую импортируется проект. Пустое значение подразумевает, что проект будет импортирован в корневую папку (Root).

Подробнее о хранилищах проектов и корневой папке см. здесь.

Параметр conflictResolveMethod определяет стратегию разрешения конфликтов (например, на сервере есть проект, и вы собираетесь импортировать проект с тем же идентификатором). Поддерживаются следующие значения:

  • Overwrite – существующий файл будет перезаписан;

  • ChangeExistingId – идентификатор существующего проекта будет изменен;

  • ChangeImportingId – идентификатор импортируемого проекта будет изменен;

  • Cancel – ни одна стратегия не применяется.

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

Параметр spaceId является необязательным. Данный параметр используется для указания хранилища проекта. Значение параметра spaceId может быть получено с помощью запроса /spaces, который описан здесь.

При импорте проекта в отключенное хранилище, вы получите сообщение об ошибке (500).

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

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

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

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

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

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

202

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

404

Ошибка – Папка проекта не существует.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Folder \"D:\\space\" not found in \"Root\""
  }
}

500

Ошибка – Хранилище отключено.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Unable to import project to disabled project space"
  }
}

500

Ошибка – Операция импорта уже запущена.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Failed to import project: import has been started earlier"
  }
}

500

Ошибка – Хранилище не существует.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Project space '15306631-c680-43df-8850-9501b6752f23' not found"
  }
}

500

Ошибка – Имя хранилища невалидно.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Failed to create UUID from string"
  }
}