Создание задачи

Создает новую задачу.

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

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

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

Ключ или идентификатор пространства

/cwm/public/api/v1/workspaces/KEY/workitems
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/workitems

Тело запроса

{
  "name": "string",
  "description": "string",
  "type": "string",
  "workflow": "string",
  "status": "string",
  "dueDate": "2023-12-27T10:33:28.999Z",
  "assignee": "string",
  "sprintId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "originalEstimate": 0,
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "attributes": [
    {
      "type": "UniString",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": "string"
    },
    {
      "type": "Number",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": 0
    },
    {
      "type": "Date",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": "2023-12-27T10:33:28.999Z"
    },
    {
      "type": "UniSelect",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": "string"
    },
    {
      "type": "Tag",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": [
        "string"
      ]
    },
    {
      "type": "User",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userName": "string"
      }
    },
    {
      "type": "TimeDuration",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": 0
    }
  ],
  "portfolioElementIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

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

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

Название задачи
name: {str:255}

description

Описание задачи
name: {str:MAX}

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

Название или идентификатор типа
type: "Дефект"
type: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

workflow

Название или идентификатор процесса
workflow: "Процесс для дефектов"
workflow: "b6ac719f-7de5-470a-997c-a83050d26b11"

status

Название или идентификатор статуса
status: "REQ TEST"
status: "b6ac719f-7de5-470a-997c-a83050d26b11"

dueDate

Дата выполнения
dueDate: "2022-03-03T21:59:08Z"

assignee

Логин или идентификатор ответственного
assignee: "ivan.ivanov"
assignee: "b6ac719f-7de5-470a-997c-a83050d26b11"

sprintId

Идентификатор спринта
sprintId: "b6ac719f-7de5-470a-997c-a83050d26b11"

originalEstimate

Оценка в секундах
originalEstimate: 56000

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

Идентификатор папки или родительской задачи
parent: "b6ac719f-7de5-470a-997c-a83050d26b11"

attributes

Список кастомных атрибутов (идентификатор + значение атрибута)

    [
      {
        "id": "b6ac719f-7de5-470a-997c-a83050d26b11",
        "value": {}
      }
    ]

Описание моделей значений атрибутов приведено ниже

portfolioElementIds

Список идентификаторов элементов портфолио
portfolioElementIds: ["b6ac719f-7de5-470a-997c-a83050d26b11"]

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

UniString

Строка {str:255}
"value": "Some string"

Number

Число
"value": -145.454443435345454

Date

Дата/время в формате ISO
"value": "2022-03-03T21:59:08Z"

UniSelect

Значение опции из списка
"value": "Medium"

Tag

Список опций тега
"value": ["tag 1", "tag 2"]

User

Логин пользователя или
"value": {"username": "roman.cherepanov"}

id

Идентификатор пользователя
"value": {"id": "b6ac719f-7de5-470a-997c-a83050d26b11"}

TimeDuration

Время в секундах (целое)
"value": 56000

Ошибки запроса

400 Bad Request

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

401 Unauthorized

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

403 Forbidden

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

500 Server Error

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

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "name": "string",
  "description": "string",
  "type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "workflow": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "status": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "category": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  },
  "endDate": "2023-12-27T10:40:03.951Z",
  "createdDate": "2023-12-27T10:40:03.951Z",
  "dueDate": "2023-12-27T10:40:03.951Z",
  "assignee": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "username": "string",
    "email": "string"
  },
  "author": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "username": "string",
    "email": "string"
  },
  "sprint": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "folder": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "originalEstimate": 0,
  "timeSpent": 0,
  "remainingEstimate": 0,
  "changedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "username": "string",
    "email": "string"
  },
  "parent": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "nodeType": "Folder"
  },
  "attributes": [
    {
      "type": "UniString",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": "string"
    },
    {
      "type": "Number",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": 0
    },
    {
      "type": "Date",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": "2023-12-27T10:40:03.951Z"
    },
    {
      "type": "UniSelect",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    },
    {
      "type": "Tag",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    },
    {
      "type": "User",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string"
      }
    },
    {
      "type": "TimeDuration",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "value": 0
    }
  ],
  "portfolios": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "elements": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ],
  "workspace": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "key": "string",
    "name": "string",
    "description": "string",
    "author": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "username": "string",
      "email": "string"
    }
  }
}

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