Skip to content

Commit 8884344

Browse files
committed
PR to remove Postman in Sesimic DDMS ADME article
1 parent dcc2cc5 commit 8884344

File tree

7 files changed

+196
-50
lines changed

7 files changed

+196
-50
lines changed

articles/energy-data-services/tutorial-seismic-ddms.md

Lines changed: 196 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,46 @@
22
title: "Tutorial: Work with seismic data by using Seismic DDMS APIs"
33
titleSuffix: Microsoft Azure Data Manager for Energy
44
description: This tutorial shows sample steps for interacting with the Seismic DDMS APIs in Azure Data Manager for Energy.
5-
author: elizabethhalper
6-
ms.author: elhalper
5+
author: akshatjoshi
6+
ms.author: akshatjoshi
77
ms.service: azure-data-manager-energy
88
ms.topic: tutorial
9-
ms.date: 3/16/2022
9+
ms.date: 3/10/2025
1010
ms.custom: template-tutorial
1111

1212
#Customer intent: As a developer, I want to learn how to use the Seismic DDMS APIs so that I can store and retrieve similar kinds of data.
1313
---
1414

1515
# Tutorial: Work with seismic data by using Seismic DDMS APIs
1616

17-
Use Seismic Domain Data Management Services (DDMS) APIs in Postman to work with seismic data in an Azure Data Manager for Energy instance.
17+
This tutorial demonstrates how to utilize Seismic Domain Data Management Services (DDMS) APIs with cURL to manage seismic data within an Azure Data Manager for Energy instance.
1818

19-
In this tutorial, you learn how to:
19+
In this tutorial, you will learn how to:
2020

2121
> [!div class="checklist"]
2222
>
2323
> * Register a data partition for seismic data.
24-
> * Use Seismic DDMS APIs to store and retrieve seismic data.
24+
> * Utilize Seismic DDMS APIs to store and retrieve seismic data.
2525
2626
For more information about DDMS, see [DDMS concepts](concepts-ddms.md).
2727

2828
## Prerequisites
29-
3029
* An Azure subscription
3130
* An instance of [Azure Data Manager for Energy](quickstart-create-microsoft-energy-data-services-instance.md) created in your Azure subscription
31+
* cURL command-line tool installed on your machine
32+
* Generate the service principal access token to call the Seismic APIs. See [How to generate auth token](how-to-generate-auth-token.md).
3233

3334
## Get your Azure Data Manager for Energy instance details
3435

35-
The first step is to get the following information from your [Azure Data Manager for Energy instance](quickstart-create-microsoft-energy-data-services-instance.md) in the [Azure portal](https://portal.azure.com/?microsoft_azure_marketplace_ItemHideKey=Microsoft_Azure_OpenEnergyPlatformHidden):
36-
37-
| Parameter | Value | Example |
38-
| ------------------ | ------------------------ |-------------------------------------- |
39-
| `client_id` | Application (client) ID | `00001111-aaaa-2222-bbbb-3333cccc4444` |
40-
| `client_secret` | Client secrets | `_fl******************` |
41-
| `tenant_id` | Directory (tenant) ID | `72f988bf-86f1-41af-91ab-xxxxxxxxxxxx` |
42-
| `base_url` | URL | `https://<instance>.energy.azure.com` |
43-
| `data-partition-id` | Data partitions | `<data-partition-name>` |
44-
45-
## Set up Postman
46-
47-
1. Download and install the [Postman](https://www.postman.com/downloads/) desktop app.
48-
2. Import the following files into Postman:
49-
50-
* [Seismic DDMS Postman collection](https://raw.githubusercontent.com/microsoft/adme-samples/main/postman/SeismicDDMS.postman_collection.json)
51-
* [Seismic DDMS Postman environment](https://raw.githubusercontent.com/microsoft/adme-samples/main/postman/SeismicDDMSEnvironment.postman_environment.json)
52-
53-
To import the files:
54-
55-
1. Select **Import** in Postman.
56-
57-
:::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":::
36+
To proceed, gather the following details from your [Azure Data Manager for Energy instance](quickstart-create-microsoft-energy-data-services-instance.md) via the [Azure portal](https://portal.azure.com/?microsoft_azure_marketplace_ItemHideKey=Microsoft_Azure_OpenEnergyPlatformHidden):
5837

59-
1. Paste the URL of each file into the search box.
60-
61-
:::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":::
62-
63-
3. Update `CURRENT_VALUE` in the Postman environment with the information that you obtained in the Azure Data Manager for Energy instance details.
38+
| Parameter | Description | Example |
39+
| ------------------ | -------------------------- |-------------------------------------- |
40+
| `client_id` | Application (client) ID | `00001111-aaaa-2222-bbbb-3333cccc4444`|
41+
| `client_secret` | Client secret | `_fl******************` |
42+
| `tenant_id` | Directory (tenant) ID | `72f988bf-86f1-41af-91ab-xxxxxxxxxxxx`|
43+
| `base_url` | Instance URL | `https://<instance>.energy.azure.com` |
44+
| `data_partition_id`| Data partition name | `opendes` |
6445

6546
## Use Seismic DDMS APIs to store and retrieve seismic data
6647

@@ -70,9 +51,51 @@ Create a legal tag that's automatically added to your Seismic DDMS environment f
7051

7152
API: **Setup** > **Create Legal Tag for SDMS**
7253

73-
Method: `POST`
54+
```bash
55+
curl --request POST \
56+
--url https://{base_url}/api/legal/v1/legaltags \
57+
--header 'Authorization: Bearer {access-token}' \
58+
--header 'Content-Type: application/json' \
59+
--header 'Data-Partition-Id: {data_partition_id}' \
60+
--data '{
61+
"name": "{tag_name}",
62+
"description": "Legal Tag added for Seismic",
63+
"properties": {
64+
"countryOfOrigin": [
65+
"US"
66+
],
67+
"contractId": "No Contract Related",
68+
"expirationDate": "2099-01-01",
69+
"dataType": "Public Domain Data",
70+
"originator": "OSDU",
71+
"securityClassification": "Public",
72+
"exportClassification": "EAR99",
73+
"personalData": "No Personal Data"
74+
}
75+
}'
76+
```
77+
**Sample Response:**
78+
```json
79+
{
80+
"name": "opendes-Seismic-Legal-Tag-Test999588567444",
81+
"description": "Legal Tag added for Seismic",
82+
"properties": {
83+
"countryOfOrigin": [
84+
"US"
85+
],
86+
"contractId": "No Contract Related",
87+
"expirationDate": "2099-01-01",
88+
"originator": "OSDU",
89+
"dataType": "Public Domain Data",
90+
"securityClassification": "Public",
91+
"personalData": "No Personal Data",
92+
"exportClassification": "EAR99"
93+
}
94+
}
95+
```
96+
97+
7498

75-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-legal-tag.png" alt-text="Screenshot that shows the API that creates a legal tag." lightbox="media/tutorial-seismic-ddms/postman-api-create-legal-tag.png":::
7699

77100
For more information, see [Manage legal tags](how-to-manage-legal-tags.md).
78101

@@ -82,9 +105,19 @@ Run basic service connection and status tests in your Azure Data Manager for Ene
82105

83106
API: **Service Verification** > **Check Status**
84107

85-
Method: `GET`
108+
```bash
109+
curl --request GET \
110+
--url http://{base_url}/seistore-svc/api/v3/svcstatus \
111+
--header 'Content-Type: application/json' \
112+
--header 'data-partition-id: {data_partition_id}'
113+
```
86114

87-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-check-service-status.png" alt-text="Screenshot that shows the API that checks the service's status." lightbox="media/tutorial-seismic-ddms/postman-api-check-service-status.png":::
115+
**Sample Response:**
116+
```json
117+
service OK
118+
```
119+
120+
88121

89122
### Tenant
90123

@@ -95,39 +128,152 @@ Create a tenant in your Azure Data Manager for Energy instance.
95128
96129
API: **Tenant** > **Register a seismic-dms tenant**
97130

98-
Method: `POST`
99131

100-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-register-tenant.png" alt-text="Screenshot that shows the API that registers a tenant." lightbox="media/tutorial-seismic-ddms/postman-api-register-tenant.png":::
132+
```bash
133+
curl --request POST \
134+
--url https://{base_url}/seistore-svc/api/v3/tenant/{data_partition_id} \
135+
--header 'Accept: application/json' \
136+
--header 'Authorization: Bearer {access-token}' \
137+
--header 'Content-Type: application/json' \
138+
--data '{
139+
"gcpid": "{data_partition_id}",
140+
"esd": "{data_partition_id}.dataservices.energy",
141+
"default_acl": "[email protected]"
142+
}'
143+
```
144+
**Sample Response:**
145+
```json
146+
{
147+
"name": "opendes",
148+
"esd": "opendes.dataservices.energy",
149+
"gcpid": "opendes",
150+
151+
"Symbol(id)": {
152+
"partitionKey": "tn-opendes",
153+
"name": "opendes"
154+
}
155+
}
156+
```
101157

102158
### Create a subproject
103159

104160
Create a subproject in your Azure Data Manager for Energy instance.
105161

106162
API: **Subproject** > **Create a new subproject**
107163

108-
Method: `POST`
109-
110-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-subproject.png" alt-text="Screenshot that shows the API that creates a subproject." lightbox="media/tutorial-seismic-ddms/postman-api-create-subproject.png":::
111-
164+
```bash
165+
curl --request POST \
166+
--url https://{base_url}/seistore-svc/api/v3/subproject/tenant/{data_partition_id}/subproject/{sesimic_subproject} \
167+
--header 'Accept: application/json' \
168+
--header 'Authorization: Bearer {access-token}' \
169+
--header 'Content-Type: application/json' \
170+
--header 'ltag: opendes-Seismic-Legal-Tag-Test999943387766' \
171+
--data '{
172+
"admin": "client_id",
173+
"access_policy": "dataset"
174+
}'
175+
```
176+
177+
**Sample Response:**
178+
```json
179+
{
180+
"name": "test999384006",
181+
"tenant": "opendes",
182+
"ltag": "",
183+
"acls": {
184+
"admins": [
185+
"data.sdms.opendes.test999384006.3a114f91-d79f-489e-b9f0-3a4ac6643924.admin@opendes.dataservices.energy"
186+
],
187+
"viewers": [
188+
"data.sdms.opendes.test999384006.3bbce754-bdfa-4fad-9672-cc9a49231058.viewer@opendes.dataservices.energy"
189+
]
190+
},
191+
"access_policy": "dataset",
192+
"enforce_key": true,
193+
"gcs_bucket": "ss-cloud-lr8faf2xnup9yxd",
194+
"Symbol(id)": {
195+
"partitionKey": "sp-test999384006",
196+
"name": "test999384006"
197+
}
198+
}
199+
```
112200
### Register a dataset
113201

114202
Register a dataset in your Azure Data Manager for Energy instance.
115203

116204
API: **Dataset** > **Register a new dataset**
117205

118-
Method: `POST`
206+
```bash
207+
curl --request POST \
208+
--url https://{base_url}/seistore-svc/api/v3/dataset/tenant/{data_partition_id}/subproject/{seismic_subproject}/dataset/{dataset_name} \
209+
--header 'Accept: application/json' \
210+
--header 'Authorization: Bearer {access-token}' \
211+
--header 'Content-Type: application/json' \
212+
--header 'ltag: {legal_tag}' \
213+
--data '{
214+
"admin": "client_id",
215+
"storage_class": "MULTI_REGIONAL",
216+
"storage_location": "US",
217+
"access_policy": "dataset",
218+
"acls": {
219+
"admins": [
220+
221+
],
222+
"viewers": [
223+
224+
]
225+
}
226+
}'
227+
```
228+
229+
230+
**Sample Response:**
231+
```json
232+
{
233+
"name": "test.sgy",
234+
"tenant": "opendes",
235+
"subproject": "test999384006",
236+
"path": "/",
237+
"ltag": "opendes-Seismic-Legal-Tag-Test999943387766",
238+
"created_by": "faK96PJHh5W-AzMK_dERdxkBBssUYVuqDjzYJcw9Al0",
239+
"last_modified_date": "Mon Mar 17 2025 12:43:38 GMT+0000 (Coordinated Universal Time)",
240+
"created_date": "Mon Mar 17 2025 12:43:38 GMT+0000 (Coordinated Universal Time)",
241+
"acls": {
242+
"admins": [
243+
244+
],
245+
"viewers": [
246+
247+
]
248+
},
249+
"gcsurl": "ss-cloud-sfibby9ril9i755-915f80ed-4804-448a-bfa5-2e70934a97a2",
250+
"ctag": "TQsxLjyufohTOFvfopendes;opendes",
251+
"Symbol(id)": {
252+
"partitionKey": "ds-opendes-test999384006-3fdd95ea0c79eb59dcb2acc48ed1d1eb057a5f94debacffac4d8e88410c5cb2804d9ba68473ea20d2d91d143b64b755e4627ad87e89530ade1cd9614a8a53545",
253+
"name": "test.sgy"
254+
},
255+
"access_policy": "dataset",
256+
"sbit": "WSUmTxkL20jQSlKW",
257+
"sbit_count": 1
258+
}
259+
```
119260

120-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-dataset.png" alt-text="Screenshot that shows the API that creates a dataset." lightbox="media/tutorial-seismic-ddms/postman-api-create-dataset.png":::
121261

122262
### Register applications
123263

124264
Register applications in your Azure Data Manager for Energy instance.
125265

126266
API: **Applications** > **Register a new application**
127267

128-
Method: `POST`
129-
130-
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-register-application.png" alt-text="Screenshot that shows the API that registers an application." lightbox="media/tutorial-seismic-ddms/postman-api-register-application.png":::
268+
```bash
269+
curl --request POST \
270+
--url 'https://{base_url}/seistore-svc/api/v3/app?email={email}&sdpath={sdpath}' \
271+
--header 'Authorization: Bearer {access-token}'
272+
```
273+
**Sample Response:**
274+
```json
275+
Status Code: 200
276+
```
131277

132278
## Next step
133279

0 commit comments

Comments
 (0)