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

Получение типа

Возвращает конкретный тип задачи.

GET /cwm/public/api/v1/workspaces/{workspace}/types/{type}

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

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

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

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

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

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "color": "Tomato",
  "icon": "string"
  "workflow": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "attributes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "type": "UniString",
      "options": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ],
      "workitemTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ],
  "progressType": "ByStatus",
  "estimatesInTime": true,
  "estimatesInStoryPoints": true,
  "showTimeTracking": true
}

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

id

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

name

Название типа

icon

Наименование иконки типа.

Возможные значения: BugSolid, BookmarkSolid, ZapSolid, Layers3Solid, CrownSolid, DocSolid, FlameSolid, EyeSolid, LightSolid, StarSolid, CheckmarkCircleSolid, FlagSolid, ChartPieSolid, UmbrellaSolid, WaveformEcgSolid, KeySolid, HeartSolid, CheckmarkSquareSolid, AlertTriangleSolid, TraySolid, BoxSolid, ChevronLeftChevronRightSolid, MessageBubble2Solid, GearSolid, GiftboxSolid, PenToolSolid, ShieldSolid, LockSolid, Square4GridSolid, BookOpenSolid, QuestionCircleSolid, MinusCircleSolid, PlusCircleSolid, InfoCircleSolid, ArrowCircleUpSolid, ArrowCircleDownSolid, AlertCircleSolid, CompassSolid, EmojiFrownSolid, EmojiSmileSolid, ArrowShapeTurnRightSolid, ArrowShapeTurnLeftSolid, ArrowDownSolid, ArrowUpSolid, CheckmarkSolid, HouseSolid, ClockSolid, ArchiveboxSolid, HeadphonesSolid, PaperPlaneSolid, ShapeRhombusSolid, Poop, ShapeTriangleSolid, ShapeCircleSolid, ShapeSquareSolid, TrashSolid, BrushPaintSolid, AsteriskSolid, RocketSolid, LeafSolid, TestIt, Pizza, Yoonion.

color

Цвет иконки типа.

Возможные значения: Sky, Mint, Yellow, Amber, Slate, Tomato, Red, Crimson, Pink, Plum, Purple, Violet, Indigo, Blue, Cyan, Teal, Green, Grass, Orange, Brown, Gold, Bronze, Gray.

workflow

Рабочий процесс по умолчанию для типа. Идентификатор и название процесса.

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

attributes

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

progressType

Способ расчета прогресса задач для данного типа.

Возможные значения: не задано, ByStatus, ByChildren, ByMetric.

estimatesInTime

Включение оценки задач данного типа в единицах времени.

estimatesInStoryPoints

Включение оценки задач данного типа в относительных единицах.

showTimeTracking

Включение учета времени в задачах данного типа.