Лицензия:
Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.
Шаг Отправить веб-запрос позволяет отправлять запросы конечным точкам REST для получения данных или публикации обновлений. Вы можете настроить ответ конечной точки REST как пользовательские выходные значения, сохранить его в виде файла и прикрепить к заданию. Пользовательские выходные значения могут использоваться для извлечения токенов для последующих вызовов REST, указания пути рабочего процесса или использоваться в качестве входных данных для других шагов.
Когда шаг выполняется, веб-запрос отправляется в конечную точку REST, определенную на этом шаге.
Шаг можно завершить, щелкнув Завершить шаг .
Настройка шага
Выполните следующие действия, чтобы настроить этот шаг:
Внимание:
Чтобы уменьшить уязвимости системы безопасности, настройте шаг Отправить веб-запрос только для доверенных веб-страниц и веб-приложений.
- Создайте или отредактируйте схему рабочего процесса, чтобы получить доступ к панели Библиотека шагов.
- Перетащите Отправить веб-запрос из панели Библиотека шагов на стрелку соединения шага на канве рабочего процесса.
Появится панель Подробная информация о шаге.
- Укажите имя шага в текстовом окне Имя шага.
- В разделе Аргументы щелкните Редактировать.
- Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
- Введите URL-адрес конечной точки REST в текстовое окно URL.
- При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:
https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/
Переменные пути появляются в разделе Переменные пути.
- При необходимости добавьте в веб запрос параметры запроса.
- Щелкните Добавить ключ и значение в разделе Параметры запроса.
- Введите ключ в текстовом окне Ключ.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Введите значение в текстовом окне Значение.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Оставьте текстовое окно Включено отмеченным.
- Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
- Если вы добавили переменные пути к URL-адресу, укажите значение для каждой переменной в разделе Переменные пути.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
Подсказка:
Нажмите Этот входной параметр поддерживает выражения Arcade и выберите выражение ArcGIS Arcade, чтобы добавить его в соответствующее текстовое поле.
- Щелкните вкладку Авторизация.
- Выберите метод аутентификации конечной точки REST и при необходимости предоставьте информацию для аутентификации.
Внимание:
Информация для аутентификации, которую вы предоставляете на шаге, не зашифрована. Вы можете надежно хранить информацию, добавив зашифрованные пользовательские настройки, на которые можно ссылаться в шаге, используя динамические свойства задания.
Примечание:
Опция Интегрированный токен позволяет вам аутентифицировать веб-запросы, когда пользователь выполняет шаг. Опция Интегрированный токен совместима только с сервисами, доступными пользователю Workflow Manager.
- При необходимости, если вы выбрали параметр Bearer Token или Ключ API щелкните Альтернативно создать токен из конечной точки.
Откроется диалоговое окно Создать токен из конечной точки.
- Настройте параметры токена, чтобы сгенерировать токен для веб-запроса.
- При необходимости, если вы выбрали параметр Bearer Token или Ключ API щелкните Альтернативно создать токен из конечной точки.
- При необходимости щелкните вкладку Заголовки, чтобы добавить в веб запрос пользовательские пары ключ-значение заголовка.
- Щелкните Добавить ключ и значение в разделе Пользовательские заголовки.
- Введите ключ в текстовом окне Ключ.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Введите значение в текстовом окне Значение.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Оставьте текстовое окно Включено отмеченным.
- Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
- При необходимости щелкните вкладку Основа, чтобы добавить данные в веб запрос.
Основа запроса поддерживает пары ключ-значение данных формы, пары ключ-значение в кодировке URL и необработанные данные в формате JSON или обычного текста.
Подсказка:
Вы также можете использовать выражение ArcGIS Arcade для получения пользовательских настроек или предоставления динамических значений в основном тексте.
- Дополнительно, если у вас есть лицензия для дополнительного модуля организации ArcGIS Workflow Manager Advanced, настройте выходные параметры шага.
- При необходимости щелкните вкладку Тест и щелкните Тестовый ответ, чтобы отправить настроенный запрос и показать его ответ.
Если веб-запрос содержит выражения Arcade, относящиеся к заданию, вы должны включить параметр Включить ID задания и указать ID задания в текстовом окне ID задания, чтобы правильно отформатировать запрос.
- Щелкните Сохранить, чтобы закрыть диалоговое окно Настройка веб-запроса.
- Перейдите на вкладку Опции.
- При необходимости настройте Опции шага.
- Вручную - запустить шаг вручную.
- Дополнительно - позволяет завершить шаг без запуска.
- Автоматически - Запускает шаг, как только он становится активным.
- Запланировать запуск - запустить шаг в соответствии с установленным вами расписанием.
- Вручную - запустить шаг вручную.
- При желании выберите один из следующих вариантов настройки справки на этом шаге:
- Нет - настройте шаг без пошаговой справки.
- Текст - настройте текст справки для шага в текстовом поле Текст.
Вы можете использовать выражения ArcGIS Arcade для предоставления динамического значения справки по шагу. Если справка по шагу содержит обычный текст и выражения Arcade, отформатируйте текст следующим образом:
'For further assistance, please contact' + JobCreator($Job) + '.'
- URL - настройте шаг, указав ссылку на справочный ресурс в текстовом поле URL.
Примечание:
Поддерживаются только форматы URL-адресов 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.
- Дополнительно, щелкните вкладку Стиль, чтобы изменить форму и цвет шага.
- Дополнительно, щелкните вкладку Описание и введите описание шага в текстовом поле Описание шага.
Подсказка:
Вкладка Описание также содержит идентификатор шага, который можно использовать с динамическими свойствами задания для получения выходных данных шага. Щелкните Копировать ID шага , чтобы скопировать идентификатор шага в буфер обмена.
Настройка параметров токена
Если конечной точке REST, на которую вы отправляете веб-запрос, требуется токен для аутентификации, выполните следующие действия, чтобы настроить шаг Отправить веб-запрос для создания токена для аутентификации:
- Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
- Введите URL-адрес конечной точки REST в текстовое окно URL.
- При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:
https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/
Переменные пути появляются в разделе Переменные пути.
- При необходимости добавьте в веб запрос параметры запроса.
- Щелкните Добавить ключ и значение в разделе Параметры запроса.
- Введите ключ в текстовом окне Ключ.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Введите значение в текстовом окне Значение.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Оставьте текстовое окно Включено отмеченным.
- Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
- Если вы добавили переменные пути к URL-адресу, укажите значение для каждой переменной в разделе Переменные пути.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
Подсказка:
Нажмите Этот входной параметр поддерживает выражения Arcade и выберите выражение ArcGIS Arcade, чтобы добавить его в соответствующее текстовое поле.
- При необходимости щелкните вкладку Заголовки, чтобы добавить в веб запрос пользовательские пары ключ-значение заголовка.
- Щелкните Добавить ключ и значение в разделе Пользовательские заголовки.
- Введите ключ в текстовом окне Ключ.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Введите значение в текстовом окне Значение.
Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.
- Оставьте текстовое окно Включено отмеченным.
- Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
- При необходимости щелкните вкладку Основа, чтобы добавить данные в веб запрос.
Основа запроса поддерживает пары ключ-значение данных формы, пары ключ-значение в кодировке URL и необработанные данные в формате JSON или обычного текста.
Подсказка:
Вы также можете использовать выражение ArcGIS Arcade для получения пользовательских настроек или предоставления динамических значений в основном тексте.
- Щелкните вкладку Токен.
- Щелкните переключатель Режим тестирования в разделе Токен.
- Вставьте пример ответа конечной точки 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 } } ]}
- Введите имя для токена в текстовом окне Выходное значение.
Это имя, которое шаг использует для ссылки на сгенерированный токен.
- Укажите выражение JSONPath через точку или в скобках в текстовом поле Путь извлечения, чтобы проанализировать ответ и вернуть сгенерированный токен.
Пример JSONPath в точечной записи:
$.access_token
Пример JSONPath в скобках:
$['access_token']
Значение отображается в столбце Образец результата.
- Щелкните Назад к шагу конфигурации, чтобы продолжить настройку шага.
Сконфигурируйте настройки выхода
Лицензия:
Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.
Вы можете сохранить ответ конечной точки REST в виде файла, прикрепить его к заданию и настроить его как пользовательские выходные значения. Выходные значения можно использовать для указания путей рабочего процесса или в качестве входных данных для других шагов. Если выходное значение не настроено для шага, код состояния HTTP сохраняется как выходное значение шага. Чтобы настроить выходные параметры шага, выполните следующие действия:
- Щелкните вкладку Выход в диалоговом окне Настройка веб-запроса.
Если диалоговое окно Настройка веб-запроса недоступно, щелкните шаг Отправить веб-запрос на канве рабочего процесса и щелкните Редактировать в разделе Аргументы на панели Подробная информация о шаге.
- При желании щелкните переключатель Включено в разделе Вложить ответ, чтобы сохранить ответ конечной точки REST в виде файла и прикрепить его к заданию.
- Дополнительно, можно настроить имя вложения и папку, в которой будет храниться ответ:
- Введите имя папки, в которой будет храниться вложение, в текстовом окне Имя папки.
Имя папки не может содержать путь к файловой системе или специальные символы. Если имя папки не указано, автоматически создается папка с именем Общие.
Примечание:
Папка содержится в элементе рабочего процесса и не является путем к файловой системе.
- Выберите одну из следующих опций Имя вложения:
- Созданный автоматически - вложению автоматически присваивается имя, с помощью следующего синтаксиса: <StepName>_<RunDate>_<RunTime>
- Пользовательский - позволяет указать пользовательское имя вложения.
- Введите имя папки, в которой будет храниться вложение, в текстовом окне Имя папки.
- Дополнительно, настройте пользовательские выходные значения для ответа точки доступа REST:
- Щелкните переключатель Режим тестирования в разделе Выходные значения.
- Вставьте пример ответа конечной точки 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 } } ]}
- Щелкните Добавить выходные данные и путь.
- Введите имя для выходного значения в текстовом окне Выходное значение.
Это имя значения, которое используется для получения пользовательского выходного значения.
- Предоставьте выражение JSONPath в точечной записи или в скобках для значения, которое вы хотите сохранить, в текстовом окне Путь извлечения.
Пример JSONPath в точечной записи:
$.location.0.name
Пример JSONPath в скобках:
$['location'][0]['name']
Значение отображается в столбце Образец результата.
- При желании повторите шаги с c по e, чтобы добавить дополнительные пользовательские выходные значения.
- Щелкните Сохранить, чтобы закрыть диалоговое окно Настройка веб-запроса.
Возвращаемое значение
Когда шаг завершен, его возвращаемое значение сохраняется, чтобы указать результат шага. Возвращаемое значение может быть немедленно оценено с использованием путей для определения следующих шагов рабочего процесса. Вы также можете получить возвращаемое значение для завершенных шагов рабочего процесса с помощью выражений ArcGIS Arcade. В следующей таблице перечислены возвращаемые значения шага:
Возвращаемое значение | Описание |
---|---|
S000001 | Шаг завершен успешно. |
F000001 | Шаг не удалось завершить успешно. |
Выходное значение
Лицензия:
Для этой функциональности требуется лицензия дополнительного модуля организации ArcGIS Workflow Manager Advanced.
Когда шаг завершен, его выходное значение сохраняется и может использоваться для определения пути, по которому следует рабочий процесс, или может использоваться в качестве входных данных для других шагов рабочего процесса. В следующей таблице перечислено выходное значение шага:
Выходные данные | Описание |
---|---|
Состояние | Возвращает код ответа HTTP, если выходное значение не настроено для шага. |
<CustomOutputValue> | Возвращает пользовательское выходное значение, которое вы настроили для шага. |
attachmentId | Возвращает массив ID вложений, добавленных к шагу. |