Блок сценария Zendesk API Request позволяет отправлять произвольные запросы к API Zendesk в формате JSON и выполнять различные действия с помощью учетной записи интеграции. Блок использует предварительно настроенную учетную запись интеграции Zendesk для авторизации и других целей. Метод HTTP можно настроить, а возвращаемые результаты обрабатываются так же, как в блоке Выполнить запрос по URL (Fetch URL).
Настройки
Текст заголовка
Название экземпляра блока.
Тип запроса
Метод для получения содержимого по указанному URL Zendesk.
Выберите один из следующих типов запросов или введите другой метод вручную:
- GET (по умолчанию)
- POST
- PUT
- PATCH
- DELETE
URL
Чтобы создать сущность в Zendesk, укажите в этом поле requests.json.
При выполнении блок формирует запрос к API Zendesk: берет URL из настроек учетной записи интеграции https://<yourcompany>.zendesk.com и добавляет к нему /api/v2/ и requests.json.
Дополнительные заголовки
Дополнительные заголовки — заголовки HTTP, добавляемые к запросу, например для аутентификации. Заголовки задаются парами «имя — значение»: имя заголовка (например, «Authorization») и его значение (например, «Bearer D18273561286FE9»). Значение может содержать переменные, которые при выполнении блока будут заменены своими значениями. По умолчанию список дополнительных заголовков пуст. Пример использования заголовков для выполнения запросов API от имени любого конечного пользователя см. Руководство по интеграции с Zendesk, раздел «Примеры сценариев Zendesk» (Zendesk Scenario Examples).
Чтобы задать заголовок, нажмите Добавить (add) и введите имя и значение.
Задаваемые поля
Этот параметр зарезервирован.
JSON в исходном виде
Свойства объекта в формате JSON.
Примечание: код и тело полученного ответа HTTP сохраняются соответственно в локальных переменных $(integrationResultCode) и $(integrationResultBody). Для диагностики используйте блок Отправить электронное письмо (EMail) или Внутреннее сообщение (Internal Message) для получения содержимого ответов, указывающих на неудачную попытку создания объекта. Подробнее см. описание переменной $(integrationResultBody).
Начальный путь в JSON результата
Если тело ответа содержит JSON, этот параметр позволяет сохранить в переменные сценария определенную часть данных. Пример: myobject.node.list[4]. По умолчанию задано «none»: путь начинается от корня возвращенного JSON.
Префикс переменных сценария для данных JSON
Эта строка используется как имя переменной для полученных разобранных данных JSON. Если указанный выше начальный путь ведет к массиву, то в зависимости от следующего параметра GetNext эта переменная будет содержать весь массив либо его первый и последующие элементы.
Использовать GetNext для перебора данных
Установите этот флажок, если данные ответа JSON по начальному пути являются массивом. В переменную сценария записывается первый элемент массива. Блок GetNext позволяет перебрать элементы, последовательно записывая следующий элемент в переменную.
Условные выходы
Ошибка
Ошибка используется, если при выполнении метода API возникла ошибка.
Нет данных
Нет данных используется, если в теле ответа HTTP нет данных.
|
