Группа: Интеграции
Подгруппа: REST
Последняя версия: 19 (Java)
Описание
Отправляет HTTP-запрос для обращения к RESTful веб-сервису.
Применение
- Отправить запрос к REST-сервису действием «Отправить запрос».
- Обработать, при необходимости, полученные данные другими действиями.
Параметры и их настройки
Свойство | Описание | Тип | Пример | Обязательность |
|---|---|---|---|---|
| Параметры | ||||
URL | URL веб-сервиса. | Robin.String | Да | |
Метод | Тип запроса. Значение по умолчанию - GET. Выпадающий список:
| Robin.String | GET | Нет |
Тело запроса | Тело запроса, которое указывается в виде JSON строки. | Robin.String | Нет | |
Параметры запроса | Параметры запроса, которые являются частью URL запроса. Заполняются в виде словаря, в котором ключ - это название параметра, а значение ключа - это значение параметра. | Robin.Dictionary | Нет | |
Параметры формы | Параметры HTML-формы для методов POST, PUT и PATCH. Заполняются в виде словаря, в котором ключ - это название параметра, а значение ключа - это значение параметра. В качестве параметра для формы можно указать путь к файлу. Если в запрос нужно добавить файл, то в словаре необходимо добавить следующую запись:
Для каждого файла, который необходимо направить в запросе, в словаре должна быть своя запись. Действие будет вычитывать файл и отправлять его содержимое в запросе. | Robin.Dictionary | Нет | |
Тип аутентификации | Тип аутентификации, которая будет использоваться в отправляемом запросе. Если не заполнить поле "Параметры аутентификации", то выбранный тип аутентификации будет проигнорирован. Значение по умолчанию - Нет. Выпадающий список из элементов:
Если "Тип аутентификации" выбран, а "Параметры аутентификации" не заполнены, то поле игнорируется. Подробнее о NTLM: https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/ | Robin.String | NTLM | Нет |
Параметры аутентификации | Параметры аутентификации для запроса. Если выбран тип аутентификации "Basic" или "NTLM", словарь должен иметь ключи "user" и "pass", содержащие значение логина и пароля соответственно. Если выбран тип "Bearer Token", словарь должен иметь ключ «token» со значением токена аутентификации. Параметры учитываются только в случае, когда в поле "Тип аутентификации" выбран любой тип кроме "Нет". Если параметры заполнены, а тип аутентификации не выбран, то поле "Параметры аутентификации" игнорируется. | Robin.Dictionary | key - user, value - user key - pass. value - password | Нет |
Заголовки запроса | Заголовки запроса. Заполняются в виде словаря, в котором ключ - это название заголовка, а значение ключа - это значение заголовка. | Robin.Dictionary | Нет | |
Тип прокси-сервера | Определяет настройки используемого прокси-сервера. Можно использовать системные настройки прокси, заданные на уровне ОС, либо настроить параметры пользовательского прокси-сервера, либо подключаться без прокси-сервера. По умолчанию используются системные настройки. Выпадающий список:
| Robin.String | Системный прокси-сервер | Нет |
Протокол прокси- сервера | Протокол прокси-сервера. Например: http, https. | Robin.String | Нет | |
Адрес прокси-сервера | Имя хоста или IP-адрес прокси-сервера. | Robin.String | Нет | |
Порт прокси-сервера | Порт прокси-сервера. | Robin.String | Нет | |
Логин прокси-сервера | Логин пользователя для подключения к прокси-серверу. | Robin.String | user | Нет |
Пароль прокси-сервера | Пароль пользователя для подключения к прокси-серверу. | Robin.Object | password | Нет |
Получить файл | Если из запроса нужно получить файлы, установите в этом параметре значение «true» и заполните поля «Путь к папке» и «Имя файла». | Robin.Boolean | true | Нет |
Путь к папке | Путь к папке, в которой нужно сохранить файл, полученный при выполнении запроса. | Robin.FolderPath | C:\doc\img | Нет |
Имя файла | Имя, которым будет назван файл, полученный при выполнении запроса. Имя нужно указывать вместе с расширением, которое должно быть у файла. | Robin.String | true | Нет |
Перезаписать | Если значение "true", и в указанной папке существует файл с таким же именем и расширением, то новый файл его перезапишет. Если "false", файл перезаписан не будет и действие вернет ошибку. | Robin.Boolean | true | Нет |
Отключить SSL | Если значение "true", то функция проверки SSL-сертификата будет отключена. | Robin.Boolean | true | Нет |
| Тайм-аут, мс | Время в миллисекундах, в течение которого действие будет ожидать ответ от веб-сервиса. Если указано «-1», действие будет ждать бесконечно долго. Значение по умолчанию: 100000 мс. | Robin.Numeric | 5000 | Нет |
| Результаты | ||||
Статус ответа | Код статуса ответа, полученного от веб-сервиса. Возвращается при использовании любого метода. | Robin.Number | - | |
Заголовки ответа | Словарь с заголовками, получаемых от веб-сервиса. Возвращается при использовании любого метода. Ключ в словаре - это название заголовка, а значение ключа - это значение заголовка. Если в ответе есть повторяющиеся заголовки, то для них в словаре будет один общий ключ со значением в виде коллекции значений этих заголовков. | Robin.Dictionary | - | |
Тело ответа | Тело ответа, полученное от веб-сервиса, в raw формате. Возвращается при использовании любого метода. | Robin.String | - | |
Идентификатор | Значение идентификатора из заголовка "Id", полученного от веб-сервиса. Возвращается только при использовании метода "POST". | Robin.String | - | |
Указатель ресурса | Значение из заголовка "Location", полученное от веб-сервиса. Имеет смысл для статусов 201, 3хх и только для метода POST. HTTP-заголовок Location возвращается в ответах HTTP-сервера в двух случаях:
При запросах, подразумевающих загрузку данных, файлов или создание сущностей, запрос может вернуть ответ 201 (created), 301 (Moved Permanently), 302 (Found). С этими ответами может быть заголовок Location со ссылкой на ресурс, которую можно использовать для доступа к нему. Соответственно Location в результате действия – это содержимое этого заголовка, если он есть. Можно оттуда достать ссылку. | Robin.String | - | |
Особые условия использования
Подробнее о REST: https://ru.wikipedia.org/wiki/REST.
Версии