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

Изменение элемента портфолио

Изменяет элемент портфолио

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

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

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

Ключ пространства workspaces/TS/porfolio_elements

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

Идентификатор элемента портфолио (guid) porfolio_elements/c310f5b2-2ecd-4e9d-bc0b-170fe6c1e5e7

Тело запроса

{

    "name": "",

    "description": "",

    "startDate": "2022-03-03T21:59:08Z",

    "endDate": "2022-03-03T21:59:08Z",

    "responsibles": ["roman.cherepanov"],

    "status": ""

}

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

name

Название элемента портфолио name: "Release 1"

description

Описание элемента портфолио description: "Text"

startDate

Дата начала элемента портфолио startDate: "2022-03-03T21:59:08Z"

endDate

Дата завершения элемента портфолио endDate: "2022-03-03T21:59:08Z"

responsibles

Список ответственных (логин пользователя) responsibles: ["roman.cherepanov"]

status

Статус элемента портфолио (название статуса) status: "At Risk"

Ошибки

Неавторизованный запрос

401 (Unauthorized)

Несуществующее пространство или элемент портфолио

404 (Not Found)

Неправильный параметр тела запроса, неправильное значение параметра в теле, несуществующий пользователь или статус

400 (Bad Request)

Отсутствие обязательного параметра тела

400 (Bad Request)

Дублирование элемента портфолио - есть элемент с таким ключом в портфолио

400 (Bad Request)

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

{

    "id": "",

    "name": "",

    "description": "",

    "startDate": "2022-03-03T21:59:08Z",

    "endDate": "2022-03-03T21:59:08Z",

    "status": {

        "id": "",

        "name": ""

        "category": {

            "id": "",

            "name": ""

        }

    },

    "responsibles": [{

                        "id": "c310f5b2-2ecd-4e9d-bc0b-170fe6c1e5e7",

                        "displayName": "System Administrator",

                        "username": "admin",

                        "email": ""

    }],

    "portfolio": {

        "id": id,

        "name": name,

        "description": description,

        "folder": {

          "id": "",

          "name": name,

          "description": None,

          "parent": None,

          "path": ""

        }

    }

}