ipr.ipr.status.list

Scope: ipr

Кто может вызывать: Любой авторизованный пользователь REST. Подробнее: Роли и права доступа

Возвращает справочник статусов карточки ИПР (значения свойства STATUS инфоблока ИПР).

HTTP: GET

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

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

Параметр Тип Обяз. Описание
Нет параметров

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

Массив объектов:

Поле Тип Описание
id string XML_ID статуса (совпадает с xmlId)
title string Название статуса, как настроено в портале (значение VALUE элемента списка)
xmlId string XML_ID статуса: NEW, SOGL, WORK, SOGL_RES, FINISHED

Порядок элементов — как в инфоблочном свойстве (SORT, ID), значение title берётся из настроек портала — переводы по умолчанию не подставляются.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.ipr.status.list.json"
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": [
              { "id": "NEW", "title": "Новый", "xmlId": "NEW" },
              { "id": "SOGL", "title": "На согласовании", "xmlId": "SOGL" },
              { "id": "WORK", "title": "В работе", "xmlId": "WORK" },
              { "id": "SOGL_RES", "title": "Результат на согласовании", "xmlId": "SOGL_RES" },
              { "id": "FINISHED", "title": "Завершён", "xmlId": "FINISHED" }
            ],
            "total": null,
            "next": null,
            "error": null
          }
        }
        

См. также

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