ipr.action.get

Scope: ipr

Кто может вызывать: Авторизованный пользователь с доступом к родительскому ИПР. Подробнее: Модель доступа

Возвращает мероприятие по ID.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
id int да ID мероприятия

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

Поле Тип Описание
id int ID мероприятия
title string Название
description string Описание (PREVIEW_TEXT)
active bool ACTIVE = Y
iprId int ID родительской карточки ИПР
iprCompetencyId int Компетенция в составе ИПР
resourceType string XML_ID типа ресурса, см. ipr.action.type.list
resourceId int ID связанного ресурса
userId int Ответственный пользователь
deadline string|null Плановая дата, YYYY-MM-DD
dateClosed string|null Дата закрытия
required bool Обязательное мероприятие (нельзя удалить без force)
addedAfterStart bool Добавлено после старта карточки
eventId int|null Связанное событие (для типа events)
actionName string Человекочитаемое имя связанного ресурса (курса/теста/файла и т. п.), если удалось определить
dateCreate string Дата создания
timestampX string Дата последнего изменения

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

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR id не передан или некорректен
NOT_FOUND Мероприятие или родительский ИПР не найдены
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.action.get.json"
          -H "Accept: application/json"
          --data-urlencode "id=12001"
        

Пример ответа

{
          "result": {
            "result": {
              "id": 12001,
              "title": "Курс «Обратная связь 360»",
              "description": "",
              "active": true,
              "iprId": 4201,
              "iprCompetencyId": 9001,
              "resourceType": "course",
              "resourceId": 305,
              "userId": 15,
              "deadline": "2026-09-30",
              "dateClosed": null,
              "required": true,
              "addedAfterStart": false,
              "eventId": null,
              "actionName": "Обратная связь 360",
              "dateCreate": "18.06.2026 12:10:02",
              "timestampX": "18.06.2026 12:10:02"
            },
            "total": null,
            "next": null,
            "error": null
          }
        }
        

См. также

Предыдущая
Следующая