Создание и управление шаблонами веб-запросов

Лицензия:

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

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

Создание шаблонов веб-запросов

Выполните следующие действия, чтобы создать шаблон веб-запроса:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас нет достаточных прав, вкладка Оформление недоступна.

3. Щелкните Шаблоны .

   Примечание:

   Если у вас нет достаточных прав, Шаблоны недоступны.

4. Щелкните вкладку Веб-запрос.

   Появится панель Веб-запрос.

   Примечание:

   Если у вас нет достаточных прав, вкладка Веб-запрос недоступна.

5. Щелкните Создать новый на панели Веб-запрос.
6. Укажите имя для шаблона веб-запроса в текстовом поле Имя.
7. Щелкните стрелку ниспадающего списка URL и выберите тип запроса, который вы хотите отправить.
8. Введите URL-адрес конечной точки REST в текстовое окно URL.
9. При желании добавьте переменные пути к URL-адресу, используя следующий синтаксис:

   https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/

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

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

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

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

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

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

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

    Подсказка:

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

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

    Внимание:

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

    Примечание:

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

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

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

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

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

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

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

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

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

    Подсказка:

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

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

    Примечание:

    Активность задания, для которого настроен шаблон, должна быть завершена, прежде чем вы сможете проверить выходное значение веб-запроса.

17. При необходимости щелкните вкладку Тест и щелкните Тестовый ответ, чтобы отправить настроенный запрос и показать его ответ.

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

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

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

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

   Параметр Сгенерировать токен из конечной точки отображается на панели Веб-запрос.

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

   https://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/

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

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

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

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

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

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

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

   Подсказка:

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

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

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

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

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

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

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

   Подсказка:

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

9. Щелкните вкладку Токен.
10. Щелкните переключатель Режим тестирования в разделе Токен.
11. Вставьте пример ответа конечной точки 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
        }
      }
    ]}

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

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

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

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

    $.access_token

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

    $['access_token']

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

14. Щелкните Назад, чтобы продолжить настройку веб-запроса.

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

Лицензия:

Для этой функциональности требуется лицензия дополнительного модуля организации 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. Щелкните Сохранить, чтобы сохранить изменения.

Редактирование шаблонов веб-запросов

Выполните следующие действия, чтобы отредактировать шаблон веб-запроса:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас нет достаточных прав, вкладка Оформление недоступна.

3. Щелкните Шаблоны .

   Примечание:

   Если у вас нет достаточных прав, Шаблоны недоступны.

4. Щелкните вкладку Веб-запрос.

   Появится панель Веб-запрос.

   Примечание:

   Если у вас нет достаточных прав, вкладка Веб-запрос недоступна.

5. Щелкните имя веб-запроса, который вы хотите отредактировать, на панели Веб-запрос.

   Подсказка:

   Вы можете отфильтровать список веб-запросов на панели Веб-запрос, введя поисковый запрос в текстовом поле Поиск шаблонов веб-запросов.

6. Обновите веб-запрос как необходимо.
7. Щелкните Сохранить, чтобы сохранить изменения.

Удаление шаблонов веб-запросов

Шаблон веб-запроса удаляется навсегда, это действие отменить нельзя. Выполните следующие действия, чтобы удалить шаблон веб-запроса:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас нет достаточных прав, вкладка Оформление недоступна.

3. Щелкните Шаблоны .

   Примечание:

   Если у вас нет достаточных прав, Шаблоны недоступны.

4. Щелкните вкладку Веб-запрос.

   Появится панель Веб-запрос.

   Примечание:

   Если у вас нет достаточных прав, вкладка Веб-запрос недоступна.

5. Щелкните имя веб-запроса, который вы хотите удалить, на панели Веб-запрос.

   Подсказка:

   Вы можете отфильтровать список веб-запросов на панели Веб-запрос, введя поисковый запрос в текстовом поле Поиск шаблонов веб-запросов.

6. Щелкните Больше действий и выберите Удалить.

   Появится сообщение для подтверждения.

7. Щелкните Да, чтобы удалить шаблон веб-запроса, либо Нет, чтобы отменить действие.