метод REST scope: task

tasks.api.scrum.epic.get

Получить поля эпика по его идентификатору

Кто может выполнять: любой пользователь, имеющий доступ к Скраму

Описание

Метод получает значения полей эпика по его идентификатору id.

Параметры

id integer обязательный

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

Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.epic.get

Ответ

HTTP-статус: 200

{
    "id": 1,
    "groupId": 143,
    "name": "эпик",
    "description": "",
    "createdBy": 1,
    "modifiedBy": 0,
    "color": "#69dafc",
    "files": {
        "ID": "136",
        "ENTITY_ID": "TASKS_SCRUM_EPIC",
        "FIELD_NAME": "UF_SCRUM_EPIC_FILES",
        "USER_TYPE_ID": "disk_file",
        "XML_ID": null,
        "SORT": "100",
        "MULTIPLE": "Y",
        "MANDATORY": "N",
        "SHOW_FILTER": "N",
        "SHOW_IN_LIST": "N",
        "EDIT_IN_LIST": "N",
        "IS_SEARCHABLE": "N",
        "SETTINGS": {
            "IBLOCK_ID": null,
            "SECTION_ID": null,
            "UF_TO_SAVE_ALLOW_EDIT": false
        },
        "USER_TYPE": {
            "USER_TYPE_ID": "disk_file",
            "CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType",
            "DESCRIPTION": "Файл (Диск)",
            "BASE_TYPE": "int",
            "TAG": [
                "DISK FILE ID",
                "DOCUMENT ID"
            ]
        },
        "VALUE": [],
        "ENTITY_VALUE_ID": 1,
        "CUSTOM_DATA": {
            "PHOTO_TEMPLATE": ""
        },
        "EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES",
        "TAG": "DOCUMENT ID"
    }
}

Возвращаемые данные

id integer

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

groupId integer

Идентификатор группы (скрама), к которой привязан эпик

name string

Название эпика

description string

Описание эпика

createdBy integer

Идентификатор пользователя, создавшего эпик

modifiedBy integer

Идентификатор пользователя, который последним изменял эпик

color string

Цвет эпика в формате HEX

files object

Объект с данными обо всех файлах, прикрепленных к эпику

Обработка ошибок

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Access denied"
}
Код Описание Значение
0 Access denied Нет доступа для просмотра данных эпика
0 Epic not found Такого эпика не существует
100 Could not find value for parameter {id} Неверно указано имя параметра или не задан параметр
100 Invalid value {stringValue} to match with parameter {id}. Should be value of type int. Неверный тип параметра

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.