title | titleSuffix | description | author | ms.author | ms.service | ms.topic | ms.date | ms.custom |
---|---|---|---|---|---|---|---|---|
Tutorial: Work with well data records by using Wellbore DDMS APIs |
Microsoft Azure Data Manager for Energy |
Learn how to work with well data records in your Azure Data Manager for Energy instance by using Wellbore Domain Data Management Services (DDMS) APIs in Postman. |
vkamani21 |
vkamani |
energy-data-services |
tutorial |
09/07/2022 |
template-tutorial |
Use Wellbore Domain Data Management Services (DDMS) APIs in Postman to work with well data in your instance of Azure Data Manager for Energy.
In this tutorial, you learn how to:
[!div class="checklist"]
- Set up Postman to use a Wellbore DDMS collection.
- Set up Postman to use a Wellbore DDMS environment.
- Send requests via Postman.
- Generate an authorization token.
- Use Wellbore DDMS APIs to work with well data records.
For more information about DDMS, see DDMS concepts.
- An Azure subscription
- An instance of Azure Data Manager for Energy created in your Azure subscription
The first step is to get the following information from your Azure Data Manager for Energy instance in the Azure portal:
Parameter | Value | Example |
---|---|---|
client_id |
Application (client) ID | 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx |
client_secret |
Client secrets | _fl****************** |
tenant_id |
Directory (tenant) ID | 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx |
base_url |
URL | https://<instance>.energy.azure.com |
data-partition-id |
Data partitions | <data-partition-name> |
You'll use this information later in the tutorial.
-
Download and install the Postman desktop app.
-
Import the following files in Postman:
To import the files:
-
Select Import in Postman.
:::image type="content" source="media/tutorial-ddms/postman-import-button.png" alt-text="Screenshot that shows the Import button in Postman." lightbox="media/tutorial-ddms/postman-import-button.png":::
-
Paste the URL of each file into the search box.
:::image type="content" source="media/tutorial-ddms/postman-import-search.png" alt-text="Screenshot that shows importing collection and environment files in Postman via URL." lightbox="media/tutorial-ddms/postman-import-search.png":::
-
-
In the Postman environment, update Current value with the information from your Azure Data Manager for Energy instance details:
-
In Postman, on the left menu, select Environments, and then select Wellbore DDMS Environment.
-
In the Current value column, enter the information from the table in the Get your Azure Data Manager for Energy instance details section of this tutorial.
:::image type="content" source="media/tutorial-wellbore-ddms/postman-environment-current-values.png" alt-text="Screenshot that shows where to enter current values in the Wellbore DDMS environment.":::
-
The Postman collection for Wellbore DDMS contains requests that you can use to interact with data about wells, wellbores, well logs, and well trajectory in your Azure Data Manager for Energy instance.
-
In Postman, on the left menu, select Collections, and then select Wellbore DDMS. Under Setup, select Get an SPN Token.
-
In the environment dropdown list in the upper-right corner, select Wellbore DDMS Environment.
:::image type="content" source="media/tutorial-wellbore-ddms/postman-get-spn-token.png" alt-text="Screenshot that shows selections for getting an SPN token and choosing an environment." lightbox="media/tutorial-wellbore-ddms/postman-get-spn-token.png":::
-
To send the request, select Send.
:::image type="content" source="media/tutorial-wellbore-ddms/postman-request-send.png" alt-text="Screenshot that shows the Send button for a request in Postman.":::
-
The request validates the actual API response code against the expected response code. Select the Test Results tab to see whether the request succeeded or failed.
Here's an example of a successful Postman call:
:::image type="content" source="media/tutorial-wellbore-ddms/postman-test-success.png" alt-text="Screenshot that shows success for a Postman call." lightbox="media/tutorial-wellbore-ddms/postman-test-success.png":::
Here's an example of a failed Postman call:
:::image type="content" source="media/tutorial-wellbore-ddms/postman-test-failure.png" alt-text="Screenshot that shows failure for a Postman call." lightbox="media/tutorial-wellbore-ddms/postman-test-failure.png":::
Successfully completing the Postman requests that are described in the following Wellbore DDMS APIs indicates successful ingestion and retrieval of well records in your Azure Data Manager for Energy instance.
Create a legal tag that's automatically added to your Wellbore DDMS environment for data compliance.
API: Setup > Create Legal Tag for WDMS
Method: POST
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-create-legal-tag.png" alt-text="Screenshot that shows the API that creates a legal tag." lightbox="media/tutorial-wellbore-ddms/postman-api-create-legal-tag.png":::
For more information, see Manage legal tags.
Create a well record in your Azure Data Manager for Energy instance.
API: Well > Create Well
Method: POST
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-create-well.png" alt-text="Screenshot that shows the API that creates a well record." lightbox="media/tutorial-wellbore-ddms/postman-api-create-well.png":::
Get the well record data for your Azure Data Manager for Energy instance.
API: Well > Well by ID
Method: GET
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-get-well.png" alt-text="Screenshot that shows the API that gets a well record by ID." lightbox="media/tutorial-wellbore-ddms/postman-api-get-well.png":::
Get the versions of each ingested well record in your Azure Data Manager for Energy instance.
API: Well > Well Versions
Method: GET
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-get-well-versions.png" alt-text="Screenshot that shows the API that gets all well versions." lightbox="media/tutorial-wellbore-ddms/postman-api-get-well-versions.png":::
Get the details of a specific version for a specific well record in your Azure Data Manager for Energy instance.
API: Well > Well Specific Version
Method: GET
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-get-specific-well-version.png" alt-text="Screenshot that shows the API that gets a specific well version." lightbox="media/tutorial-wellbore-ddms/postman-api-get-specific-well-version.png":::
Delete a specific well record from your Azure Data Manager for Energy instance.
API: Clean up > Well Record
Method: DELETE
:::image type="content" source="media/tutorial-wellbore-ddms/postman-api-delete-well.png" alt-text="Screenshot that shows the API that deletes a well record." lightbox="media/tutorial-wellbore-ddms/postman-api-delete-well.png":::
Read the following tutorial to learn how to use the sdutil command-line tool to load seismic data into Seismic Store:
[!div class="nextstepaction"] Tutorial: Use sdutil to load data into Seismic Store