Перейти к основному содержимому

IssueDto

Задача

idstring

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

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
numberstring

Номер задачи. Обеспечивает контроль уникальности в пределах проекта. Если не указан при загрузке, то заполняется внутренним кодом.

Possible values: <= 30 characters

Default value: Внутренний код (ПрефиксПроекта-N)
Example: CRM-1
titlestringrequired

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

Possible values: <= 150 characters

Example: Разработать API для задач
project object

Проект

oneOf
idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Название

Example: Управление заказами
prefixstring

Префикс

Example: CRM
external-urlstring

Внешний идентификатор задачи для гиперссылки. Полный URL или часть (UUID) для подстановки в шаблон.

Example: http://1Cbase/issue/CRM-1
statusstring

Статус задачи

Possible values: [open, in-progress, under-review, done, closed]

Default value: open
Example: in-progress
descriptionstring

Описание задачи. В формате HTML. При превышении 500 символов в свойствах задачи не выгружается (пустое значение и description-is-too-large: true). Требуется отдельная подгрузка (из .../issues/{key}/description), аналогично вложениям.

Example: <body><p>Текст описания</p></body>
description-is-too-largeboolean

Признак превышения объема description.

Default value: false
createdinstant, dateTime

Дата создания. Для выгрузки: можно изменить формат в настройках групповой разработки для проекта. По умолчанию — в универсальном формате с часовым поясом. Для загрузки: принимаются основные форматы по ISO-8601. Если в значении не указан часовой пояс, он берется из настроек групповой разработки проекта.

Default value: текущая дата
Example: 2025-01-02T10:11:12.345Z | 2025-01-02T10:11:12Z | 2025-01-02 10:11:12+03:00 | 2025-01-02 10:11:12
completedinstant, dateTime

Дата завершения (выполнения, закрытия, удаления). Формат аналогичен "created".

Default value: текущая дата (при записи соответствующего состояния)
Example: 2025-01-02T10:11:12.345Z
updatedinstant, dateTime

Дата последнего обновления из внешней системы. Формат аналогичен "created".

Default value: текущая дата
Example: 2025-01-02T10:11:12.345Z
importedinstant, dateTime

Дата загрузки задачи из внешней системы. Для созданных локально — пустое значение. Формат аналогичен "created".

Default value: текущая дата
Example: 2025-01-02T10:11:12.345Z
author object

Создатель задачи

oneOf
idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Имя

Example: Масков И.Р.
assignee object

Исполнитель задачи

oneOf
idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Имя

Example: Масков И.Р.
release object

Релиз, в который включена задача

oneOf
idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Наименование

target-branch object

Релизная или основная ветка для заливки результата

oneOf
idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Имя

Example: issue/CRM-1
application object

Приложение

idstring

Идентификатор ссылки

Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
namestring

Название

Example: CRM-dev
urlstring

URL

Example: http://127.0.0.1:9090/applications/CRM-dev
branch-usagestring

Режим выбора ветки разработки

Possible values: [create-new-branch, use-main-branch, choose-branch]

Default value: create-new-branch или use-main-branch (в зависимости от настроек проекта)
Example: create-new-branch
branches object[]

Ветки

  • Array [
  • idstring

    Идентификатор ссылки

    Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
    namestring

    Имя

    Example: issue/CRM-1
    application object

    Приложение

    idstring

    Идентификатор ссылки

    Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
    namestring

    Название

    Example: CRM-dev
    urlstring

    URL

    Example: http://127.0.0.1:9090/applications/CRM-dev
  • ]
  • attachments object[]

    Вложения (прикрепленные файлы). В свойствах задачи выгружается только описание. Само тело файла необходимо передавать отдельно (.../issues/{key}/attachment). Вместо тела файла можно заполнить URL ресурса для гиперссылки из формы задачи.

  • Array [
  • namestring

    Имя файла

    Example: Скриншот.jpg
    sizestring

    Строковое представление размера

    Example: 100,5 КБ
    urlstring

    URL адрес для открытия по гиперссылке

    Example: http://1Cbase/files/0193dde1-d10b-7c3a-a0eb-4a0ba0319908
  • ]
  • labelsstring[]

    Метки (тэги)

    reviewers object[]

    Проверяющие задачи

  • Array [
  • user object
    idstring

    Идентификатор ссылки

    Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
    namestring

    Имя

    Example: Масков И.Р.
    statestring

    Результат проверки

    Possible values: [not-approved, approved, needs-work]

    Default value: not-approved
    Example: approved
  • ]
  • deletion-markboolean

    Пометка удаления

    Default value: false
    Example: false
    version-stampuuid

    Идентификатор версии объекта. Если заполнено в теле запроса изменения объекта - выполняется оптимистическая блокировка.

    Example: 0193dde1-d10b-7c3a-a0eb-4a0ba0319908
    time-stampinstant

    Отметка времени изменения объекта (при использовании настройки регистрации изменений для задач). Если заполнено в теле запроса изменения объекта - выполняется оптимистическая блокировка.

    Default value: текущая дата
    Example: 2025-01-02T10:11:12.345Z
    IssueDto
    {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "number": "CRM-1",
    "title": "Разработать API для задач",
    "project": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "Управление заказами",
    "prefix": "CRM"
    },
    "external-url": "http://1Cbase/issue/CRM-1",
    "status": "in-progress",
    "description": "<body><p>Текст описания</p></body>",
    "description-is-too-large": false,
    "created": "2025-01-02T10:11:12.345Z | 2025-01-02T10:11:12Z | 2025-01-02 10:11:12+03:00 | 2025-01-02 10:11:12",
    "completed": "2025-01-02T10:11:12.345Z",
    "updated": "2025-01-02T10:11:12.345Z",
    "imported": "2025-01-02T10:11:12.345Z",
    "author": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "Масков И.Р."
    },
    "assignee": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "Масков И.Р."
    },
    "release": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "string"
    },
    "target-branch": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "issue/CRM-1",
    "application": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "CRM-dev",
    "url": "http://127.0.0.1:9090/applications/CRM-dev"
    }
    },
    "branch-usage": "create-new-branch",
    "branches": [
    {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "issue/CRM-1",
    "application": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "CRM-dev",
    "url": "http://127.0.0.1:9090/applications/CRM-dev"
    }
    }
    ],
    "attachments": [
    {
    "name": "Скриншот.jpg",
    "size": "100,5 КБ",
    "url": "http://1Cbase/files/0193dde1-d10b-7c3a-a0eb-4a0ba0319908"
    }
    ],
    "labels": [
    "Блок Контрагенты"
    ],
    "reviewers": [
    {
    "user": {
    "id": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "name": "Масков И.Р."
    },
    "state": "approved"
    }
    ],
    "deletion-mark": false,
    "version-stamp": "0193dde1-d10b-7c3a-a0eb-4a0ba0319908",
    "time-stamp": "2025-01-02T10:11:12.345Z"
    }