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

Получение портфеля

Возвращает конкретный портфель.

GET /cwm/public/api/v1/workspaces/{workspace}/portfolios/{portfolioId}

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

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

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

portfolioId

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

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "folder": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "elements": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ],
  "workflow": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  }
}

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

id

Идентификатор портфеля

name

Название портфеля

description

Описание портфеля

folder

Папка, в которую добавлен портфель. Идентификатор и название папки.

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
}

elements

Список элементов портфеля. Название и идентификатор элемента.

  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  }

workflow

Процесс, определяющий статусную модель портфеля. Название и идентификатор процесса.

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
}