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

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

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

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

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

To configure the step, do the following:

Внимание:

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

1. Create or edit a workflow diagram to access the Step Library panel.
2. Перетащите Отправить веб-запрос из панели Библиотека шагов на стрелку соединения шага на холсте рабочего процесса.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. В разделе Аргументы щелкните Редактировать.
5. Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
6. Введите URL-адрес конечной точки REST в текстовое окно URL.
7. При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

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

8. Если вы добавили переменные пути к URL-адресу, укажите значение для каждой переменной в разделе Переменные пути.

   You can also use ArcGIS Arcade expressions to provide a dynamic value.

   Подсказка:

   Click the This input supports Arcade Expressions button and choose an ArcGIS Arcade expression to add it to its associated text box.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Оставьте текстовое окно Включено отмеченным.
   5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
10. Щелкните вкладку Авторизация.
11. Выберите метод аутентификации конечной точки REST и при необходимости предоставьте информацию для аутентификации.

    Внимание:

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

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

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

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

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

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

    Подсказка:

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

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

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

16. Щелкните Сохранить, чтобы закрыть диалоговое окно Настройка веб-запроса.
17. Click the Options tab.
18. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Примечание:

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

19. Optionally, provide help text for the step in the Step Help text box.

    You can also use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you'll need to format the text as follows:

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

20. Optionally, click the Style tab to change the shape and color of the step.
21. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Примечание:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

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

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

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Оставьте текстовое окно Включено отмеченным.
   5. Повторите шаги от a до d, чтобы добавить больше пар ключ-значение.
4. При желании щелкните вкладку Заголовки, чтобы добавить в веб запрос пользовательские пары ключ-значение заголовка.
   1. Щелкните Добавить ключ и значение в разделе Пользовательские заголовки.
   2. Введите ключ в текстовом окне Ключ.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

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

   Подсказка:

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

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

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

   {"access_token": "12345abcde",
   "expires_in":7199,
   "spatialReference": {
     "wkid": 4326,
     "latestWkid": 4326
   },
   "locations": [
     {
       "name": "380 New York Street",
       "extent": {
         "xmin": -117.196701,
         "ymin": 34.055489
       }
     }
   ]}

9. Введите имя для токена в текстовом окне Выходное значение.

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

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

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

    $.access_token

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

    $['access_token']

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

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

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

Лицензия:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

Роль ArcGIS Workflow Manager Server 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
      },
      "locations": [
        {
          "name": "380 New York Street",
          "extent": {
            "xmin": -117.196701,
            "ymin": 34.055489
          }
        }
      ]}

   3. Щелкните Добавить выходные данные и путь.
   4. Введите имя для выходного значения в текстовом окне Выходное значение.

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

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

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

      $.locations.0.name

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

      $['locations'][0]['name']

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

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

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

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

Лицензия:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

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