Руководство. Работа с хорошо записями данных с помощью API-интерфейсов DDMS для доставки

Используйте API-интерфейсы доменных Управление данными служб (DDMS) в Postman, чтобы работать с хорошо данными в вашем экземпляре Azure Data Manager для энергетики.

В этом руководстве описано следующее:

  • Настройте Postman для использования коллекции Well Delivery DDMS.
  • Настройте Postman для использования среды DDMS хорошой доставки.
  • Отправка запросов через Postman.
  • Создайте маркер авторизации.
  • Используйте API-интерфейсы DDMS для хорошой доставки данных.

Дополнительные сведения о DDMS см . в концепциях DDMS.

Необходимые компоненты

Получение сведений об экземпляре Azure Data Manager для энергетики

Первым шагом является получение следующих сведений из экземпляра Azure Data Manager для энергии в портал Azure:

Параметр Значение Пример
CLIENT_ID Идентификатор приложения (клиент) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
CLIENT_SECRET Секреты клиента _fl******************
TENANT_ID Идентификатор каталога (клиента) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx
SCOPE Идентификатор приложения (клиент) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
base_uri URI-адрес <instance>.energy.azure.com
data-partition-id Секции данных <instance>-<data-partition-name>

Эти сведения будут использоваться далее в руководстве.

Настройка Postman

  1. Скачайте и установите классическое приложение Postman .

  2. Импортируйте следующие файлы в Postman:

    Чтобы импортировать файлы, выполните следующие действия.

    1. Создайте два JSON-файла на компьютере путем копирования данных, содержащихся в файлах коллекции и среды.

    2. В Postman выберите импорт файлов>>выбора файлов, а затем выберите два JSON-файла на компьютере.

    3. В разделе "Импорт сущностей " в Postman выберите "Импорт".

      Screenshot that shows importing collection and environment files in Postman.

  3. В среде Postman обновите CURRENT VALUE с информацией из экземпляра Azure Data Manager для энергетики:

    1. В Postman в меню слева выберите "Среды" и выберите "Среда WellDelivery".

    2. В столбце CURRENT VALUE введите сведения из таблицы в разделе "Получение сведений об экземпляре Azure Data Manager для энергии" этого руководства.

    Screenshot that shows where to enter current values in the Well Delivery DDMS environment.

Отправка запроса Postman

Коллекция Postman для DDMS "Хорошо доставка" содержит запросы, которые можно использовать для взаимодействия с данными о скважинах, скважинах, журналах и траектории в экземпляре Azure Data Manager для энергетики.

Пример отправки запроса Postman см. в руководстве по Wellbore DDMS.

Создание маркера для API

Создайте маркер, который можно использовать для работы с API-интерфейсами DDMS для хорошой доставки:

  1. Импортируйте следующую команду cURL в Postman для создания маркера носителя. Используйте значения из экземпляра Azure Data Manager для энергетики.

     curl --location --request POST 'https://login.microsoftonline.com/{{TENANT_ID}}/oauth2/v2.0/token' \
         --header 'Content-Type: application/x-www-form-urlencoded' \
         --data-urlencode 'grant_type=client_credentials' \
         --data-urlencode 'client_id={{CLIENT_ID}}' \
         --data-urlencode 'client_secret={{CLIENT_SECRET}}' \
         --data-urlencode 'scope={{SCOPE}}'  
    

    Screenshot of cURL code in a Well Delivery DDMS token.

  2. Используйте выходные данные маркера для обновления access_token в среде DDMS хорошой доставки. Затем маркер носителя можно использовать в качестве типа авторизации в других вызовах API.

Использование API-интерфейсов DDMS для хорошой доставки данных

Успешное завершение запросов Postman, описанных в следующих API-интерфейсах DDMS для доставки, указывает на успешное прием и получение записей хорошо в экземпляре Azure Data Manager для энергетики.

Создание хорошой записи

Создайте запись в экземпляре Azure Data Manager для энергетики.

API: UC1>entity_create хорошо

Метод: PUT

Screenshot that shows the API that creates a well record.

Создание записи wellbore

Создайтезаписьную запись в экземпляре Azure Data Manager для энергетики.

API: UC1>entity_create wellbore

Метод: PUT

Screenshot that shows the API that creates a wellbore record.

Получение хорошой версии

Получение хорошой записи на основе определенного идентификатора.

API: UC1>entity_create хорошо Копировать

Метод: GET

Screenshot that shows the API that gets a well record based on a specific well ID.

Создание плана действий

Создайте план действий.

API: план действий entity_create UC1>

Метод: PUT

Screenshot that shows the API that creates an activity plan.

Получение плана действий по идентификатору

Получите объект плана действий для определенного идентификатора хорошо.

API: UC2>activity_plans_by_well

Метод: GET

Screenshot of the API that gets an activity plan by well ID.

Удаление записи wellbore

Вы можете удалить запись скважины в экземпляре Azure Data Manager для энергетики с помощью API-интерфейсов DDMS для хорошой доставки. На следующем снимке экрана показан пример.

Screenshot that shows how to use an API to delete a wellbore record.

Удаление хорошой записи

Вы можете удалить запись в экземпляре Azure Data Manager для энергетики с помощью API-интерфейсов DDMS для хорошой доставки. На следующем снимке экрана показан пример.

Screenshot that shows how to use an API to delete a well record.

Следующие шаги

Перейдите к следующему руководству, чтобы узнать, как работать с хорошо данными с помощью API Wellbore DDMS: