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

Создание спринта

Создает спринт

POST /cwm/public/api/v1/workspaces/{workspace}/sprints

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

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

Ключ или идентификатор пространства
workspaces/KEY/sprints
workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/sprints/{sprintId}

Тело запроса

{
  "agileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "startDate": "2024-10-29T19:06:13.606Z",
  "endDate": "2024-10-29T19:06:13.606Z",
  "workdays": 0,
  "copyViewsFromSprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "estimatedStoryPoints": 0,
  "team": [
    {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "daysOff": 0,
      "hoursPerDay": 0
    }
  ]
}

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

agileId

Идентификатор расширения Agile, в котором создается спринт

name

Название спринта name="Sprint 1"

description

Описание спринта

startDate

Дата начала спринта

endDate

Дата завершения спринта

workdays

Кол-во рабочих дней в спринте

copyViewsFromSprint

Перенести представления из другого спринта. Идентификатор спринта, из которого нужно перенести представления

estimatedStoryPoints

Оценка в сторипоинтах

team

Команда спринта. Список участников с указанием количества рабочих часов в день и количества дней отпуска.

Тело запроса для участника команды спринта

userId

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

hoursPerDay

Количество рабочих часов в дне

daysOff

Количество дней отпуска (выходных) у пользователя в спринте

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "startDate": "2024-10-29T19:06:13.641Z",
  "endDate": "2024-10-29T19:06:13.641Z",
  "state": "New",
  "workdays": 0,
  "isBacklog": true,
  "team": [
    {
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "hoursPerDay": 0,
      "daysOff": 0
    }
  ]
}

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

Описана в подразделе Получение спринта

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

Отказ доступа к объекту

404 (Not Found)

Несуществующее расположение

500 (Server Error)

Внутренняя ошибка сервиса