Freigeben über

Tutorial: Arbeiten mit Bohrlochdatensätzen mithilfe der Well Delivery DDMS-APIs

  • Artikel

Verwenden Sie die APIs für Well Delivery Domain Data Management Services (DDMS) in Postman, um mit Bohrlochdaten in Ihrer Instanz von Azure Data Manager for Energy zu arbeiten.

In diesem Tutorial lernen Sie Folgendes:

  • Richten Sie Postman ein, um eine Well Delivery DDMS-Sammlung zu verwenden.
  • Richten Sie Postman ein, um eine Well Delivery DDMS-Umgebung zu verwenden.
  • Senden Sie Anforderungen über Postman.
  • Generieren Sie ein Autorisierungstoken.
  • Verwenden Sie Well Delivery DDMS-APIs, um mit Bohrlochdatensätzen zu arbeiten.

Weitere Informationen zu DDMS finden Sie unter DDMS-Konzepte.

Voraussetzungen

Abrufen der Instanzdetails für Azure Data Manager for Energy

Der erste Schritt besteht darin, die folgenden Informationen aus Ihrer Instanz von Azure Data Manager for Energy im Azure-Portal abzurufen:

Parameter Wert Beispiel
CLIENT_ID Anwendungs-ID (Client) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
CLIENT_SECRET Geheime Clientschlüssel _fl******************
TENANT_ID Verzeichnis-ID (Mandant) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx
SCOPE Anwendungs-ID (Client) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
base_uri URI <instance>.energy.azure.com
data-partition-id Datenpartitionen <instance>-<data-partition-name>

Sie werden diese Informationen später im Tutorial verwenden.

Einrichten von Postman

  1. Laden Sie die Postman-Desktop-App herunter, und installieren Sie sie.

  2. Importieren Sie die folgenden Dateien in Postman:

    So importieren Sie die Dateien

    1. Erstellen Sie zwei JSON-Dateien auf Ihrem Computer, indem Sie die Daten aus den Sammlungs- und Umgebungsdateien kopieren.

    2. Wählen Sie in Postman Importieren>Dateien>Dateien auswählen aus, und wählen Sie dann die beiden JSON-Dateien auf Ihrem Computer aus.

    3. Wählen Sie in Postman unter Entitäten importieren die Option Importieren aus.

      Screenshot that shows importing collection and environment files in Postman.

  3. Aktualisieren Sie CURRENT VALUE in der Postman-Umgebung mit den Informationen aus Ihrer Instanz von Azure Data Manager for Energy:

    1. Wählen Sie in Postman im linken Menü Umgebungen und dann WellDelivery-Umgebung aus.

    2. Geben Sie in der Spalte AKTUELLER WERT die Informationen aus der Tabelle im Abschnitt Abrufen von Azure Data Manager for Energy-Instanzdetails dieses Tutorials ein.

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

Senden einer Postman-Anforderung

Die Postman-Sammlung für Well Delivery DDMS enthält Anforderungen, die Sie verwenden können, um mit Daten über Bohrlöcher, Bohrungen, Bohrlochprotokolle und Bohrlochverläufe in Ihrer Instanz für Azure Data Manager for Energy zu interagieren.

Ein Beispiel zum Senden einer Postman-Anforderung finden Sie im Wellbore DDMS-Tutorial.

Generieren eines Tokens für APIs

Generieren Sie ein Token, das Sie für die Arbeit mit Well Delivery DDMS-APIs verwenden können:

  1. Importieren Sie den folgenden cURL-Befehl in Postman, um ein Bearertoken zu generieren. Verwenden Sie die Werte aus Ihrer Instanz von Azure Data Manager for Energy.

     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. Verwenden Sie die Tokenausgabe, um access_token in Ihrer Well Delivery DDMS-Umgebung zu aktualisieren. Anschließend können Sie das Bearertoken als Autorisierungstyp in anderen API-Aufrufen verwenden.

Verwenden der Well Delivery DDMS-APIs zum Arbeiten mit Bohrlochdatensätzen

Der erfolgreiche Abschluss der Postman-Anforderungen, die in den folgenden Well Delivery DDMS-APIs beschrieben sind, zeigt die erfolgreiche Erfassung und den Abruf von Bohrlochdatensätzen in Ihrer Instanz für Azure Data Manager for Energy an.

Erstellen eines Bohrlochdatensatzes

Erstellen Sie einen Bohrlochdatensatz in Ihrer Instanz von Azure Data Manager for Energy.

API: UC1>entity_create well

Methode: PUT

Screenshot that shows the API that creates a well record.

Erstellen eines Bohrungsdatensatzes

Erstellen Sie einen Bohrlochdatensatz in Ihrer Instanz von Azure Data Manager for Energy.

API: UC1>entity_create wellbore

Methode: PUT

Screenshot that shows the API that creates a wellbore record.

Abrufen einer Bohrlochversion

Rufen Sie einen Bohrlochdatensatz auf Grundlage einer bestimmten Bohrloch-ID ab.

API: UC1>entity_create well Copy

Methode: GET

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

Erstellen eines Aktivitätsplans

Erstellen Sie einen Aktivitätsplan.

API: UC1>entity_create activityplan

Methode: PUT

Screenshot that shows the API that creates an activity plan.

Abrufen des Aktivitätsplans über die Bohrloch-ID

Rufen Sie das Aktivitätsplanobjekt für eine bestimmte Bohrloch-ID ab.

API: UC2>activity_plans_by_well

Methode: GET

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

Löschen eines Bohrungsdatensatzes

Sie können einen Bohrungsdatensatz in Ihrer Instanz für Azure Data Manager for Energy mithilfe der Well Delivery DDMS-APIs löschen. Im folgenden Screenshot wird ein Beispiel gezeigt.

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

Löschen eines Bohrlochdatensatzes

Sie können einen Bohrungsdatensatz in Ihrer Instanz für Azure Data Manager for Energy mithilfe der Well Delivery DDMS-APIs löschen. Im folgenden Screenshot wird ein Beispiel gezeigt.

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

Nächste Schritte

Im nächsten Tutorial erfahren Sie, wie Sie die Wellbore DDMS-APIs für die Arbeit mit Bohrlochdaten verwenden:

Tutorial: Arbeiten mit Bohrlochdatensätzen mithilfe der Wellbore DDMS-APIs