Наверх

Добавление и настройка шага Отправить Веб-запрос

В этом разделе

  1. Настройка шага
  2. Настройка параметров токена
  3. Сконфигурируйте настройки выхода
  4. Возвращаемое значение
  5. Выходное значение
Лицензия:

Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.

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

Когда шаг выполняется, веб-запрос отправляется в конечную точку REST, определенную на этом шаге.

Шаг можно завершить, щелкнув Завершить шаг Complete Step.

Настройка шага

Для настройки шага выполните следующее:

Внимание:

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

  1. Создайте или отредактируйте схему рабочего процесса, чтобы получить доступ к панели Библиотека шагов.
  2. Перетащите Отправить веб-запрос из панели Библиотека шагов на стрелку соединения шага на канве рабочего процесса.

    Более подробно о добавлении шагов к схеме рабочего процесса

    Появится панель Подробная информация о шаге.

  3. Укажите имя шага в текстовом окне Имя шага.
  4. В разделе Аргументы щелкните Редактировать.
  5. Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
  6. Введите URL-адрес конечной точки REST в текстовое окно URL.
  7. При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:
    https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/

    Переменные пути появляются в разделе Переменные пути.

  8. При необходимости добавьте в веб запрос параметры запроса.
    1. Щелкните Добавить ключ и значение в разделе Параметры запроса.
    2. Введите ключ в текстовом окне Ключ.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    3. Введите значение в текстовом окне Значение.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    4. Оставьте текстовое окно Включено отмеченным.
    5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
  9. Если вы добавили переменные пути к URL-адресу, укажите значение для каждой переменной в разделе Переменные пути.

    Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    Подсказка:

    Нажмите Этот входной параметр поддерживает выражения Arcade This input supports Arcade expressions и выберите выражение Arcade, чтобы добавить его в соответствующее текстовое поле.

  10. Щелкните вкладку Авторизация.
  11. Выберите метод аутентификации конечной точки REST и при необходимости предоставьте информацию для аутентификации.
    Внимание:

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

    Примечание:

    Опция Интегрированный токен позволяет вам аутентифицировать веб-запросы, когда пользователь выполняет шаг. Опция Интегрированный токен совместима только с сервисами, доступными пользователю Workflow Manager.

    1. При необходимости, если вы выбрали параметр Bearer Token или Ключ API щелкните Альтернативно создать токен из конечной точки.

      Откроется диалоговое окно Создать токен из конечной точки.

    2. Настройте параметры токена, чтобы сгенерировать токен для веб-запроса.
  12. При необходимости щелкните вкладку Заголовки, чтобы добавить в веб запрос пользовательские пары ключ-значение заголовка.
    1. Щелкните Добавить ключ и значение в разделе Пользовательские заголовки.
    2. Введите ключ в текстовом окне Ключ.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    3. Введите значение в текстовом окне Значение.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    4. Оставьте текстовое окно Включено отмеченным.
    5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
  13. При необходимости щелкните вкладку Основа, чтобы добавить данные в веб запрос.

    Основа запроса поддерживает пары ключ-значение данных формы, пары ключ-значение в кодировке URL и необработанные данные в формате JSON или обычного текста.

    Подсказка:

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

  14. Дополнительно, если у вас есть лицензия для дополнительного модуля организации ArcGIS Workflow Manager Advanced, настройте выходные параметры шага.
  15. При необходимости щелкните вкладку Тест и щелкните Тестовый ответ, чтобы отправить настроенный запрос и показать его ответ.

    Если веб-запрос содержит выражения Arcade, относящиеся к заданию, вы должны включить параметр Включить ID задания и указать ID задания в текстовом окне ID задания, чтобы правильно отформатировать запрос.

  16. Щелкните Сохранить, чтобы закрыть диалоговое окно Настройка веб-запроса.
  17. Перейдите на вкладку Опции.
  18. При необходимости настройте Опции шага.
    • Вручную - запустить шаг вручную.
      • Дополнительно - позволяет завершить шаг без запуска.
    • Автоматически - Запускает шаг, как только он становится активным.
      Примечание:

      Если для схемы рабочего процесса настроен автоматический запуск последовательности шагов, включая шаг Запустить сервис GP, то после истечения срока действия токена пользователя запускаемые шаги не будут выполняться автоматически. Для выполнения дополнительных автоматизированных шагов без ручного вмешательства требуется Дополнительный модуль организации ArcGIS Workflow Manager Advanced.

    • Запуск по расписанию - запуск шага по заданному расписанию.

      Более подробно об опциях расписания

  19. При желании выберите один из следующих вариантов настройки справки на этом шаге:
    • Нет - настройте шаг без пошаговой справки.
    • Текст - настройте текст справки для шага в текстовом поле Текст.

      Вы можете использовать выражения ArcGIS Arcade для предоставления динамического значения справки по шагу. Если справка по шагу содержит обычный текст и выражения Arcade, выполните форматирование текста следующим образом:

      
'For further assistance, please contact' + JobCreator($Job) + '.'

    • URL - настройте шаг, указав ссылку на справочный ресурс в текстовом поле URL.
      Примечание:

      Шаги, выполняемые в веб-приложении, поддерживают только форматы HTTP и HTTPS URL. Шаги, выполняемые в ArcGIS Pro, поддерживают HTTP, HTTPS и форматы файлов.

      Вы также можете использовать выражения Arcade для предоставления динамического значения. Если URL-адрес содержит обычный текст и выражения Arcade, выполните форматирование текста следующим образом:

      
'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

      Выполните следующие настройки для опции Автоматически кодировать результат Arcade:

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

  20. Дополнительно, щелкните вкладку Стиль, чтобы изменить форму и цвет шага.
  21. Дополнительно, щелкните вкладку Описание и введите описание шага в текстовом поле Описание шага.
    Подсказка:

    Вкладка Описание также содержит идентификатор шага, который можно использовать с динамическими свойствами задания для получения выходных данных шага. Щелкните Копировать ID шага Copy Step ID, чтобы скопировать идентификатор шага в буфер обмена.

Настройка параметров токена

Если конечной точке REST, на которую вы отправляете веб-запрос, требуется токен для аутентификации, выполните следующие действия, чтобы настроить шаг Отправить веб-запрос для создания токена для аутентификации:

  1. Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
  2. Введите URL-адрес конечной точки REST в текстовое окно URL.
  3. При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:
    https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/

    Переменные пути появляются в разделе Переменные пути.

  4. При необходимости добавьте в веб запрос параметры запроса.
    1. Щелкните Добавить ключ и значение в разделе Параметры запроса.
    2. Введите ключ в текстовом окне Ключ.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    3. Введите значение в текстовом окне Значение.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    4. Оставьте текстовое окно Включено отмеченным.
    5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
  5. Если вы добавили переменные пути к URL-адресу, укажите значение для каждой переменной в разделе Переменные пути.

    Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    Подсказка:

    Нажмите Этот входной параметр поддерживает выражения Arcade This input supports Arcade expressions и выберите выражение Arcade, чтобы добавить его в соответствующее текстовое поле.

  6. При необходимости щелкните вкладку Заголовки, чтобы добавить в веб запрос пользовательские пары ключ-значение заголовка.
    1. Щелкните Добавить ключ и значение в разделе Пользовательские заголовки.
    2. Введите ключ в текстовом окне Ключ.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    3. Введите значение в текстовом окне Значение.

      Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

    4. Оставьте текстовое окно Включено отмеченным.
    5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
  7. При необходимости щелкните вкладку Основа, чтобы добавить данные в веб запрос.

    Основа запроса поддерживает пары ключ-значение данных формы, пары ключ-значение в кодировке URL и необработанные данные в формате JSON или обычного текста.

    Подсказка:

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

  8. Щелкните вкладку Токен.
  9. Щелкните переключатель Режим тестирования в разделе Токен.
  10. Вставьте пример ответа конечной точки REST в текстовое окно Образец ответа.

    Пример ответа в формате JSON:

    {"access_token": "12345abcde",
"expires_in":7199,
"spatialReference": {
  "wkid": 4326,
  "latestWkid": 4326
},
"location": [
  {
    "name": "380 New York Street",
    "extent": {
      "xmin": -117.196701,
      "ymin": 34.055489
    }
  }
]}
  11. Введите имя для токена в текстовом окне Выходное значение.

    Это имя, которое шаг использует для ссылки на сгенерированный токен.

  12. Укажите выражение JSONPath через точку или в скобках в текстовом поле Путь извлечения, чтобы проанализировать ответ и вернуть сгенерированный токен.

    Пример JSONPath в точечной записи:

    $.access_token

    Пример JSONPath в скобках:

    $['access_token']

    Значение отображается в столбце Образец результата.

  13. Щелкните Назад к шагу конфигурации, чтобы продолжить настройку шага.

Сконфигурируйте настройки выхода

Лицензия:

Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.

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

  1. Щелкните вкладку Выход в диалоговом окне Настройка веб-запроса.

    Если диалоговое окно Настройка веб-запроса недоступно, щелкните шаг Отправить веб-запрос на канве рабочего процесса и щелкните Редактировать в разделе Аргументы на панели Подробная информация о шаге.

  2. При желании щелкните переключатель Включено в разделе Вложить ответ, чтобы сохранить ответ конечной точки REST в виде файла и прикрепить его к заданию.
  3. Дополнительно, можно настроить имя вложения и папку, в которой будет храниться ответ:
    1. Введите имя папки, в которой будет храниться вложение, в текстовом окне Имя папки.

      Имя папки не может содержать путь к файловой системе или специальные символы. Если имя папки не указано, автоматически создается папка с именем Общие.

      Примечание:

      Папка содержится в элементе рабочего процесса и не является путем к файловой системе.

    2. Выберите одну из следующих опций Имя вложения:
      • Созданный автоматически - вложению автоматически присваивается имя, с помощью следующего синтаксиса: <StepName>_<RunDate>_<RunTime>
      • Пользовательский - позволяет указать пользовательское имя вложения.
  4. Дополнительно, настройте пользовательские выходные значения для ответа точки доступа REST:
    1. Щелкните переключатель Режим тестирования в разделе Выходные значения.
    2. Вставьте пример ответа конечной точки REST в текстовое окно Образец ответа.

      Пример ответа в формате JSON:

      {"access_token": "",
"expires_in":7199,
"spatialReference": {
  "wkid": 4326,
  "latestWkid": 4326
},
"location": [
  {
    "name": "380 New York Street",
    "extent": {
      "xmin": -117.196701,
      "ymin": 34.055489
    }
  }
]}
    3. Щелкните Добавить выходные данные и путь.
    4. Введите имя для выходного значения в текстовом окне Выходное значение.

      Это имя значения, которое используется для получения пользовательского выходного значения.

    5. Предоставьте выражение JSONPath в точечной записи или в скобках для значения, которое вы хотите сохранить, в текстовом окне Путь извлечения.

      Пример JSONPath в точечной записи:

      $.location.0.name

      Пример JSONPath в скобках:

      $['location'][0]['name']

      Значение отображается в столбце Образец результата.

    6. При желании повторите шаги с c по e, чтобы добавить дополнительные пользовательские выходные значения.
  5. Щелкните Сохранить, чтобы закрыть диалоговое окно Настройка веб-запроса.

Возвращаемое значение

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

Возвращаемое значениеОписание

S000001

Шаг завершен успешно.

F000001

Шаг не удалось завершить успешно.

Выходное значение

Лицензия:

Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.

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

Выходные данныеОписание

Состояние

Возвращает код ответа HTTP, если выходное значение не настроено для шага.

<CustomOutputValue>

Возвращает пользовательское выходное значение, которое вы настроили для шага.

attachmentId

Возвращает массив ID вложений, добавленных к шагу.

Связанные разделы

  • Создание и управление схемами рабочих процессов
  • Шаблоны шагов
  • Оценка результатов шагов
  • Настройка путей
  • Динамические свойства заданий
  • Тестирование динамических свойств заданий

Отзыв по этому разделу?

В этом разделе
  1. Настройка шага
  2. Настройка параметров токена
  3. Сконфигурируйте настройки выхода
  4. Возвращаемое значение
  5. Выходное значение