Udostępnij za pośrednictwem


Samouczek: praca z rekordami danych przy użyciu interfejsów API usługi Well Delivery DDMS

Użyj interfejsów API usługi Well Delivery Domain Zarządzanie danymi Services (DDMS) w narzędziu Postman, aby pracować z dobrze danymi w twoim wystąpieniu usługi Azure Data Manager for Energy.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

  • Skonfiguruj narzędzie Postman do korzystania z kolekcji DDMS Well Delivery.
  • Skonfiguruj narzędzie Postman do korzystania ze środowiska DDMS Well Delivery.
  • Wysyłanie żądań za pośrednictwem narzędzia Postman.
  • Generowanie tokenu autoryzacji.
  • Korzystaj z interfejsów API DDMS well delivery, aby pracować z rekordami danych.

Aby uzyskać więcej informacji na temat DDMS, zobacz Pojęcia dotyczące DDMS.

Wymagania wstępne

Uzyskiwanie szczegółów wystąpienia usługi Azure Data Manager dla wystąpienia energii

Pierwszym krokiem jest uzyskanie następujących informacji z wystąpienia usługi Azure Data Manager for Energy w witrynie Azure Portal:

Parametr Wartość Przykład
CLIENT_ID Identyfikator aplikacji (klient) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
CLIENT_SECRET Klucze tajne klienta _fl******************
TENANT_ID Identyfikator katalogu (dzierżawcy) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx
SCOPE Identyfikator aplikacji (klient) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
base_uri Identyfikator URI <instance>.energy.azure.com
data-partition-id Partycje danych <instance>-<data-partition-name>

Te informacje będą używane w dalszej części tego samouczka.

Konfigurowanie narzędzia Postman

  1. Pobierz i zainstaluj aplikację klasyczną Postman .

  2. Zaimportuj następujące pliki w narzędziu Postman:

    Aby zaimportować pliki:

    1. Utwórz dwa pliki JSON na komputerze, kopiując dane w plikach kolekcji i środowiska.

    2. W narzędziu Postman wybierz pozycję Importuj>pliki Wybierz pliki>, a następnie wybierz dwa pliki JSON na komputerze.

    3. W obszarze Importuj jednostki w narzędziu Postman wybierz pozycję Importuj.

      Screenshot that shows importing collection and environment files in Postman.

  3. W środowisku Postman zaktualizuj bieżącą wartość przy użyciu informacji z wystąpienia usługi Azure Data Manager for Energy:

    1. W narzędziu Postman w menu po lewej stronie wybierz pozycję Środowiska, a następnie wybierz pozycję WellDelivery Environment.

    2. W kolumnie CURRENT VALUE (BIEŻĄCA WARTOŚĆ ) wprowadź informacje z tabeli w sekcji Pobieranie usługi Azure Data Manager dla wystąpienia energii w tym samouczku.

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

Wysyłanie żądania postman

Kolekcja Postman dla usługi Well Delivery DDMS zawiera żądania, których można użyć do interakcji z danymi dotyczącymi studni, studni, dobrze dzienników i dobrze trajektorii w wystąpieniu usługi Azure Data Manager for Energy.

Aby zapoznać się z przykładem wysyłania żądania Postman, zobacz samouczek Wellbore DDMS.

Generowanie tokenu dla interfejsów API

Wygeneruj token, którego można użyć do pracy z interfejsami API DDMS Well Delivery:

  1. Zaimportuj następujące polecenie cURL w narzędziu Postman, aby wygenerować token elementu nośnego. Użyj wartości z wystąpienia usługi 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. Użyj danych wyjściowych tokenu, aby zaktualizować access_token je w środowisku DDMS well delivery. Następnie możesz użyć tokenu elementu nośnego jako typu autoryzacji w innych wywołaniach interfejsu API.

Używanie interfejsów API DDMS well delivery do pracy z rekordami danych

Pomyślne ukończenie żądań Postman opisanych w następujących interfejsach API usługi Well Delivery DDMS wskazuje pomyślne pozyskiwanie i pobieranie rekordów dobrze w wystąpieniu usługi Azure Data Manager for Energy.

Tworzenie rekordu dobrze

Utwórz dobry rekord w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: dobrze entity_create UC1>

Metoda: PUT

Screenshot that shows the API that creates a well record.

Tworzenie rekordu wellbore

Utwórz rekord wellbore w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: UC1>entity_create wellbore

Metoda: PUT

Screenshot that shows the API that creates a wellbore record.

Uzyskaj wersję dobrze

Uzyskaj dobry rekord na podstawie określonego identyfikatora źródła.

Interfejs API: UC1>entity_create dobrze kopiuj

Metoda: GET

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

Tworzenie planu działania

Utwórz plan działania.

INTERFEJS API: UC1>entity_create activityplan

Metoda: PUT

Screenshot that shows the API that creates an activity plan.

Pobieranie planu działania według dobrego identyfikatora

Pobierz obiekt planu działania dla określonego identyfikatora źródła.

Interfejs API: UC2>activity_plans_by_well

Metoda: GET

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

Usuwanie rekordu wellbore

Rekord wellbore można usunąć w wystąpieniu usługi Azure Data Manager for Energy przy użyciu interfejsów API usługi Well Delivery DDMS. Poniższy zrzut ekranu przedstawia przykład.

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

Usuwanie rekordu źródła

Rekord dobrze można usunąć w wystąpieniu usługi Azure Data Manager for Energy przy użyciu interfejsów API usługi Well Delivery DDMS. Poniższy zrzut ekranu przedstawia przykład.

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

Następne kroki

Przejdź do następnego samouczka, aby dowiedzieć się, jak pracować z dobrze danymi przy użyciu interfejsów API wellbore DDMS: