Связь объектов с веб-службами REST

Вы можете добавить действие веб-службы REST для объекта в Дизайнере объектов для использования широкого спектра возможностей интеграции с другими приложениями, такими как средство автоматизации (Ivanti Automation).

Данная расширенная функция предназначена для лиц, знакомым с технологиями, такими как REST, JSON, Postman и Swagger. Если вам нужна поддержка использования этой функции от профессиональных сервисов Ivanti, обратитесь к своему поставщику.

Перед конфигурацией ПО Service Desk

Перед тем, как начать конфигурацию ПО Service Desk, рекомендуется сначала использовать такие средства, как Swagger и Postman, для разработки и конфигурации взаимодействия с конечными системами, что может помочь в отладке любых проблем. После проверки взаимодействия таким способом вы можете сконфигурировать ПО Service Desk для воспроизведения подобного взаимодействия.

Также рекомендуется создавать эти новые части в экземпляре разработки, тщательно их тестировать, а затем перемещать в рабочую среду - сразу не применять новые данные в рабочей среде. Для получения дополнительной информации см. раздел Использование проектов REST в рабочих средах.

Конфигурация ПО Service Desk

После проектирования и проверки вызовов RESTful API за пределами ПО Service Desk можно начать воспроизводить их в программах дизайнеров Service Desk. Имейте в виду, что вызов REST может быть выполнен с созданием экземпляра объекта с действием REST. Во время повторного обновления и сохранения объекта другой вызов REST не отправляется.

Первым шагом является добавление действия веб-службы REST для объекта, который нужно использовать для интеграции с конечной системой.

Для добавления действия веб-службы REST для объекта:
  1. В Дизайнере объектов откройте объект, с которым нужно использовать веб-службу REST.
  2. Выберите объект вверху дерева Атрибуты и затем на панели Свойства нажмите значок три точки рядом с элементом Действия.
    Появится диалог выбора действия.
  3. Выберите Веб-служба REST в списке Доступные элементы, а затем нажмите Значок стрелки вправо.
    Веб-служба REST будет помещена в список Выбранные элементы.
  4. Нажмите OK и сохраните изменения.
    Диалог выбора действия будет закрыт, и новый элемент Веб-службы REST отобразится в таблице Свойство.
    Кроме того, для объекта будут созданы новые атрибуты: Текст запроса создания сервиса REST, Статус создания сервиса REST, URI-адрес запроса создания сервиса REST. Взаимосвязь Текст шаблона запроса создания сервиса REST с новым объектом списка ссылок называют - ObjectBody. (Где Object - это имя, для которого было добавлено действие).

    5. Вы должны создать окна для любых новых созданных объектов.

  5. На панели Свойства нажмите значок три точки рядом с элементом Веб-службы REST.
    Отобразится диалог "Веб-службы REST".
  6. На вкладке Запрос введите URI-адрес нужной конечной системы в поле URI-адрес конечной системы.

    7. В этом поле URI-адрес конечной системы также можно использовать заполнитель. Обычно это делается для значения исправления, ИСПРАВИТЬ.

  7. Выберите нужное - POST (Публиковать), PATCH (Исправить) или DELETE (Удалить).
    Значение публикации обычно используется для создания элементов, а исправления - для обновления существующих элементов. Если вам нужно создать элемент с помощью веб-службы REST, а затем обновить этот же элемент с помощью веб-службы REST, необходимо создать два объекта: один для создания элемента с помощью публикации, а другой - для обновления элемента с помощью исправления.
  8. В раскрывающемся списке Тип данных выберите тип отправляемых данных.
  9. В списке Тип аутентификации выберите нужный тип аутентификации: Нет, Общая, Ключ API (заголовок), OAuth2 (учетные данные клиента) или OAuth2 (пароль) вместе с требуемыми дополнительными параметрами.
  10. Нажмите OK.

Могут возникнуть ситуации, когда нужно временно отключить работу REST. Это можно сделать, отменив установку параметра Включить в диалоге веб-сервиса REST.

Если вам нужно выполнить дальнейшие действия с записью, созданной с помощью веб-службы REST, необходимо указать путь к уникальному идентификатору, получаемому от внешнего приложения, и местоположение в Service Desk, где необходимо хранить эту информацию.

Для сохранения уникальных идентификаторов:

  1. На вкладке Назначение ответа в диалоге выбора действий в поле Источник укажите путь к уникальному идентификатору, полученному во внешнем приложении.
    Вы можете использовать точечную нотацию для указания элементов в исходных данных. Введите *, если нужно использовать ответ целиком.
  2. В поле Цель укажите атрибут Service Desk строкового типа, где нужно сохранить полученное значение в ПО Service Desk.
    Он находится в форме {_Request/Field}.
  3. В раскрывающемся списке Принять выберите тип отправляемых данных.
    Если будет выбран формат XML, укажите Пространства имен XML, разделив пробелами имена нескольких пространств имен. Например, xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.example.com/example/"
  4. Нажмите OK.

Теперь после конфигурации связи между объектом Service Desk и конечной системой вы можете указать текст для отправляемых данных. Данные должны иметь формат JSON или XML. Некоторые конечные системы могут принимать различные данные. Например, функция автоматизации Ivanti Automation предоставляет единую конечную систему, которая принимает данные для нескольких модулей выполнения с требуемым модулем, указанным в тексте.

Именно поэтому взаимосвязь Шаблон текста запроса создания сервиса Rest для объекта списка ссылок ObjectBody создается во время добавления действия веб-службы REST. Это позволяет создать список ссылок (для получения информации см. раздел Создание справочных списков) для хранения различных данных, а затем, как часть процедуры, предоставить механизм для выбора соответствующего экземпляра списка ссылок (например, с использованием типа значения в автоматическом действии; см. раздел Указание динамических значений для экземпляров автоматических действий). С добавлением заполнителей, подобных тем, которые используются при указании динамических значений в автоматических действиях, в ваш ObjectBody вы можете включать значения для добавления, полученные из экземпляров объектов в ПО Service Desk. Если вы используете переменные-заполнителей, добавьте их в контекст объекта RESTful.

Каждый объект с действием REST должен иметь не менее одного элемента в соответствующем списке ссылок, который содержит требуемый текст данных.

Вы можете использовать такое средство, как Swagger, для вызова на конечной системе для упрощения проектирования данных.

Для ознакомления с примером веб-службы REST для автоматизации выполнения запросов с помощью автоматизации Ivanti см. сведения в Сообществе пользователей Ivanti.