Перейти к содержанию

Получение элементов портфолио

Возвращает пагинированный список элементов портфолио по указанным параметрам.

GET /cwm/public/api/v1/workspaces/{workspace}/portfolio-elements

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

workspace (обязательный)

Ключ или идентификатор пространства
/cwm/public/api/v1/workspaces/KEY/workitems
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/workitems

name

Имя элемента для поиска (вхождение подстроки)
?name=Версия 1

folderId

Идентификатор содержащей папки
?folderId=f5ce1753-ced5-4992-beb9-7408c1a56cf8

portfolioId

Идентификатор портфолио
?portfolioId=f5ce1753-ced5-4992-beb9-7408c1a56cf8

status

Название или идентификатор статуса элемента
?status=Под риском
?status=f5ce1753-ced5-4992-beb9-7408c1a56cf8

Возможно комбинирование параметров фильтрации.

Тело успешного ответа 200

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "startDate": "2023-12-29T10:52:30.494Z",
      "endDate": "2023-12-29T10:52:30.494Z",
      "status": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "category": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      },
      "responsibles": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayName": "string",
          "username": "string",
          "email": "string"
        }
      ],
      "portfolio": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    }
  ]
}

Описание возвращаемой модели

items

Список элементов. Модель элемента портфолио описана в таблице "Описание возвращаемой модели элемента портфолио" подраздела "Получение элемента портфолио"