Получение информации о проекте

Данная операция возвращает информацию о проекте.

URL

/project/info

Метод

GET

Диапазон

project_view

Тип ответа

sync

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

Имя Тип Обязательный Описание

prjUUID

строка

да

ID проекта.

prjUUID должен быть действительным ID проекта.

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

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

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

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/project/info?prjUUID=71b09445-cba1-4932-85db-193d9d837124

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

{
  "name": "My project",
  "uuid": "5bf66407-0de5-4870-817a-18b95b886403",
  "type": "project",
  "path": "Recovered projects",
  "owner": "administrator",
  "created": 1601647977117,
  "modified": 1696509322682,
  "accessed": 1714490798903,
  "createdBy": "administrator",
  "modifiedBy": "administrator",
  "accessedBy": "administrator",
  "description": "",
  "ownerType": "User",
  "rights": [
    "Read",
    "Write",
    "Execute",
    "Export data",
    "Create project",
    "Create report"
  ],
  "spaceId": "95306631-c680-43df-8850-9501b6752f23",
  "damaged": false,
  "versionC": 30586,
  "versionU": 30586,
  "directory": "00000002"
}

где

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

name

строка

Имя проекта.

uuid

строка

ID проекта.

type

строка

Тип данных (например, "project").

path

строка

Путь к проекту.

owner

строка

Владелец проекта.

created

число

Время создания проекта.

modified

число

Время, когда проект был изменен.

accessed

число

Время, когда проект был открыт.

createdBy

строка

Создатель проекта.

modifiedBy

строка

Пользователь, который изменил проект.

accessedBy

строка

Пользователь, который имел доступ к проекту.

description

строка

Описание проекта.

ownerType

строка

Тип владельца проекта.

isOwnerOrAdmin

булевый

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

spaceId

строка

ID хранилища проекта.

damaged

булевый

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

versionC

число

Версия сервера, в которой проект был создан.

versionU

число

Версия сервера, в которой проект был обновлен.

directory

строка

Каталог проекта.

Значения параметра spaceId можно увидеть через запрос /project/spaces (подробнее см. здесь).

Массив rights может иметь одно или несколько значений:

  • Read – права на открытие папки.

  • Write – права на изменение папки.

  • Execute – права на выполнение проектов в папке.

  • Export data – права на экспорт данных из папки.

  • Create project – права на создание проекта в папке.

  • Create report – права на создание отчета в папке.

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

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

200

Успех.

{
  "name": "My project",
  "uuid": "5bf66407-0de5-4870-817a-18b95b886403",
  "type": "project",
  "path": "Recovered projects",
  "owner": "administrator",
  "created": 1601647977117,
  "modified": 1696509322682,
  "accessed": 1714490798903,
  "createdBy": "administrator",
  "modifiedBy": "administrator",
  "accessedBy": "administrator",
  "description": "",
  "ownerType": "User",
  "rights": [
    "Read",
    "Write",
    "Execute",
    "Export data",
    "Create project",
    "Create report"
  ],
  "spaceId": "95306631-c680-43df-8850-9501b6752f23",
  "damaged": false,
  "versionC": 30586,
  "versionU": 30586,
  "directory": "00000002"
}

403

Ошибка – prjUUID не является проектом.

{
  "error": {
    "code": 403,
    "title": "",
    "message": "Item dbcbe4bc-c41b-4b0a-ba37-ca0a37855a1f is not a project"
  }
}

404

Ошибка – проект с указанным ID не найден на сервере.

{
  "error": {
    "code": 404,
    "title": "",
    "message": "Project 322cf2c1-d054-4963-a0e0-f5b189906301 not found"
  }
}

500

Ошибка – доступ запрещен (пользователь не обладает соответствующими правами).

{
  "error": {
    "code": 500,
    "title": "access denied; Available rights: [none]; Required rights: [read];",
    "message": "Error: access denied while calling method PADatabase::FindItem;\r\nAvailable rights: [none]; Required rights: [read];"
  }
}