Creatio administration

Добавление параметров ответа и запроса типа “коллекция"

Коллекцией (или массивом) является набор элементов. Есть два типа параметров коллекции:

Простая коллекция. Любой параметр можно представить в виде коллекции, установив признак “Является массивом". Простые коллекции являются массивами значений одного типа данных. Каждое значение является отдельным элементом коллекции. Например, “1, 2, 3” — это простой массив значений целых чисел, а “Бостон, Нью Йорк, Чикаго”  —  простой массив текстовых значений.

Коллекция объекта. Для добавления этого типа коллекции выберите “Объект” в поле [Тип данных] параметра вызова или ответа. Каждый элемент в коллекции “Объект” может иметь разные типы параметров. Такие параметры элемента коллекции являются вложенными параметрами корневого параметра. Например, коллекция контактов может содержать вложенные параметры для передачи имени контакта, даты рождения и возраста (Рис. 1).

Рис. 1 — Пример коллекции контактов

scr_web_service_object_collection_example.png 

Коллекция такой структуры выглядит так:

Contact name

Date of birth

Age

Jane Barber

04/12/1991

27

Aaron Shepard

10/24/1985

33

Kate Smith

12/05/1989

29

Creatio может передавать коллекции данных в веб-сервис и обрабатывать ответы веб-сервиса, содержащие коллекции. Если веб-сервис поддерживает получение и/или отправку массивов данных, то параметры типа “коллекция“ можно использовать как для вызова веб-сервиса, так и для обработки его ответа.

На заметку

Тип данных “коллекция” можно выбрать только для параметров типа “Параметр тела”. Этот тип параметров недоступен для методов с запросами типа GET.

Для добавления параметра вызова или ответа типа “коллекция“ с вложенными параметрами:

1.Перейдите на страницу настройки метода веб-сервиса и кликните [Добавить параметр] на вкладке [Параметры вызова] или [Обработка ответа].

2.В поле [Тип данных] укажите “Объект” .

3.Добавьте вложенные параметры нужного типа по кнопке [Добавить параметр] —> [Добавить вложенный параметр] (Рис. 2).

Рис. 2Добавление вложенного параметра в коллекцию

scr_web_service_object.png 

Например, параметр ответа веб-сервиса типа “коллекция“ , который получает записи контактов с сервера, имеет такой вид (Рис. 3):

Рис. 3 — Вложенные параметры ответа

scr_web_service_object_parameters.png 

Значение JSONPath для вложенных параметров указывается как суффикс JSONPath корневого параметра. Например, если в поле [Путь к элементу (JSONPath)] корневого параметра указано значение “$.records”, а значение “$.records.name” должно быть указано для вложенного параметра “Имя”, то в поле [Путь к элементу (JSONPath)] вложенного параметра достаточно указать “$.records”.

Параметры ответа веб-сервиса типа “коллекция” могут использоваться в качестве входящих параметров элемента бизнес-процесса [Вызвать веб-сервис]. Подробно использование коллекций в бизнес-процессах рассмотрено в отдельной статье.

Смотрите далее

Проверка работы интеграции с веб-сервисом

Был ли данный материал полезен?

Как можно улучшить эту статью?