Получение задачи

Возвращает конкретную задачу. В модели задачи возвращаются только заполненные атрибуты.

GET /cwm/public/api/v1/workspaces/{workspace}/workitems/{workitem}

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

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

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

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

Ключ или идентификатор задачи
?workitem=TS-13
?workitem=f5ce1753-ced5-4992-beb9-7408c1a56cf8

Тело успешного ответа 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"
    }
  },
  "startDate": "2024-01-29T12:07:40.404Z",
  "endDate": "2023-12-27T10:29:43.385Z",
  "createdDate": "2023-12-27T10:29:43.385Z",
  "dueDate": "2023-12-27T10:29:43.385Z",
  "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,
  "storyPoints": 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:29:43.385Z"
    },
    {
      "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"
    }
  }
}

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

id

Идентификатор задачи

key

Ключ задачи

name

Название задачи

description

Описание задачи. Формат разметки описания приведен в разделе Форматирование текста

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"
          }
      }

startDate

Плановая дата начала задачи

endDate

Дата фактического завершения задачи

createdDate

Дата создания задачи

dueDate

Плановая дата выполнения задачи

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

Оценка задачи в секундах

timeSpent

Суммарное затраченное время по задаче в секундах

remainingEstimate

Оставшееся время в секундах (разница между оценкой и затраченным временем)

storyPoints

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

changedBy

Автор последнего изменения задачи. Идентификатор, отображаемое имя, логин и почта пользователя.

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "username": "string",
    "email": "string"
}

parent

Родительская задача или папка. Идентификатор и тип элемента
(Folder / WorkItem).

  {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "nodeType": "Folder"
  }

attributes

Список атрибутов задачи. Не заполненные атрибуты также возвращаются.
Тип атрибута, идентификатор, название атрибута, описание атрибута, значение атрибута (формат данных описан в подразделе Создание задачи)

  [{
        "type": "UniString",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "value": "string"
  }]

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"
    }
}

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

500 (Server Error)

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