Получить значение из JSON по пути

Робот «Получить значение из JSON по пути» извлекает одно значение из структурированного ответа для дальнейших действий.

Видимая часть формы настройки в Битрикс24. Скриншот показывает поля действия; он не подтверждает выполнение учебного примера.

Для кого и какую задачу решает

Автору интеграционного процесса, которому нужно получить одно поле из вложенного ответа: имя клиента, количество первой позиции или флаг согласования.

Копирование вложенного значения вручную делает процесс зависимым от формы исходного документа. Робот использует явный путь из ключей и индексов и сообщает, найдено ли значение. Отсутствующее поле можно обработать отдельно от поля со значением null.

Параметры и подготовка

Поле	Как заполнить
Исходный JSON (JSON)	Обязательное поле
Путь в JSON, например ["items",0,"name"]; []: весь документ (PATH)	Обязательное поле

Перед настройкой выберите, откуда процесс получит каждое значение: постоянная настройка, поле карточки или результат предыдущего шага. Подписи в таблице соответствуют полям робота. Коды в скобках помогают различать похожие параметры при передаче данных между шагами.

Как использовать

1. Передайте исходный JSON в одноимённое поле. Текст должен быть полным корректным документом, а не фрагментом без внешних скобок.
2. Запишите путь JSON-массивом: строковые ключи в кавычках, номера элементов числами. Первый элемент массива имеет индекс 0.
3. Для всего документа передайте путь []. Не используйте запись с точками вроде items.0.name: требуется массив пути.
4. Проверьте статус, затем признак найденного значения и его тип. Передавайте значение дальше в формате, ожидаемом следующим действием.

Как заполнить JSON-поля

Исходный JSON (JSON)

{
  "items": [
    {
      "name": "Кабель"
    }
  ]
}

Передайте полный документ из предыдущего шага. Документ может иметь любой допустимый JSON-тип.

Приведён пример JSON-объекта. Для исходного документа допустимость массива [] или скалярного значения определяется выбранной операцией и схемой; этот пример не ограничивает все возможные входы объектами.

Путь в JSON, например ["items",0,"name"]; []: весь документ (PATH)

[
  "items",
  0,
  "name"
]

Строки обозначают точные ключи, числа неотрицательные индексы от нуля. Пустой путь [] выбирает весь документ.

Это массив: внешние квадратные скобки обязательны. Пустой массив [] отличается от объекта {}; возможность пустого списка определяется правилами этого поля, описанными ниже.

Учебный пример и ожидаемый результат

Исходный документ {"items":[{"name":"Кабель"}]}, путь ["items",0,"name"]. Ожидается JSON-значение "Кабель" и включённый признак наличия. Для пути ["items",1,"name"] значение не будет найдено. Найденное поле с null, напротив, сохраняет положительный признак наличия.

Пример показывает подготовленные учебные данные. Фактический результат зависит от переданных значений и доступных данных вашего процесса.

Что возвращает и как продолжить процесс

• «Значение в JSON» (value).
• «Тип значения» (value_type).
• «Значение найдено» (found).

Возвращаются значение в JSON, его тип и признак наличия. Кавычки вокруг строки являются частью JSON-представления. Пустой массив или объект также может быть найденным значением; не заменяйте проверку наличия проверкой непустого текста.

Выход «Статус выполнения» проверяйте перед передачей результата дальше. При отрицательном статусе прочитайте «Пояснение ошибки» и направьте процесс на исправление исходных данных. Успешный статус подтверждает выполнение действия; содержательные признаки результата проверяйте отдельно.

Ограничения и разбор ошибок

Путь ["items",0,"name"] означает поле name первого элемента items. Индексы начинаются с 0. Путь [] возвращает весь документ. Отсутствующий ключ отличается от найденного null. Размер входного JSON: до 1 МБ, массива: до 10000 элементов, вложенность: до 64 уровней.

Робот читает только переданный документ, не запрашивает обновлённые данные по ссылке и не создаёт недостающие поля. Проверьте точные имена ключей и индексы, если ожидаемое значение отсутствует. Регистр в названиях ключей имеет значение.