Självstudie: Arbeta med Petrel-dataposter med hjälp av Petrel DDMS-API:er
Använd API:er för Petrel Domain Datahantering Services (DDMS) i Postman för att arbeta med Petrel-data i din instans av Azure Data Manager for Energy.
I den här självstudien lär du dig att:
- Konfigurera Postman för att använda en Petrel DDMS-samling.
- Konfigurera Postman för att använda en Petrel DDMS-miljö.
- Skicka begäranden via Postman.
- Generera en auktoriseringstoken.
- Använd Petrel DDMS-API:er för att arbeta med Petrel-dataposter och -projekt.
Mer information om DDMS finns i DDMS-begrepp.
Förutsättningar
- En Azure-prenumeration
- En instans av Azure Data Manager for Energy som skapats i din Azure-prenumeration
Hämta information om Azure Data Manager for Energy-instansen
Det första steget är att hämta följande information från din Azure Data Manager for Energy-instans i Azure-portalen:
| Parameter | Värde | Exempel |
|---|---|---|
CLIENT_ID |
App-ID (klient-ID) | 3dfxxxxxxxxxxxxxxxxxxxxxx |
CLIENT_SECRET |
Klienthemligheter | _fl****************** |
TENANT_ID |
Katalog-ID (klientorganisation) | 72fxxxxxxxxxxxx |
SCOPE |
App-ID (klient-ID) | 3dfxxxxxxxxxxxxxxxxxxxxxxx |
HOSTNAME |
URI | <instance>.energy.azure.com |
DATA_PARTITION_ID |
Datapartitioner | <instance>-<data-partition-name> |
Du använder den här informationen senare i självstudien.
Konfigurera Postman
Importera följande fil i Postman: Petrel DDMS Postman-samlingen.
Skapa en Postman-miljö med hjälp av de värden som du fick tidigare. Miljön bör se ut ungefär så här:
Generera en token som ska användas i API:er
Postman-samlingen för Petrel DDMS innehåller begäranden som du kan använda för att interagera med dina Petrel-projekt. Den innehåller också en begäran om att köra frågor mot aktuella Petrel-projekt och poster i din Azure Data Manager for Energy-instans.
I Postman går du till den vänstra menyn och väljer Samlingar och sedan Petrel DDMS. Under Installation väljer du Hämta token.
I listrutan miljö i det övre högra hörnet väljer du Petrel DDMS-miljö.
Om du vill skicka begäran väljer du Skicka.
Den här begäran genererar en åtkomsttoken och tilldelar den som auktoriseringsmetod för framtida begäranden.
Du kan också generera en token med hjälp av cURL-kommandot i Postman eller en terminal för att generera en ägartoken. Använd värdena från din Azure Data Manager for Energy-instans.
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}}'
Om du vill använda den här cURL-genererade token måste du uppdatera access_token i variablerna Collection med värdet efter Bearer i svaret.
Använda Petrel DDMS-API:er för att arbeta med Petrel-projekt
Att slutföra Postman-begäranden som beskrivs i följande Petrel DDMS-API:er indikerar lyckad interaktion med dina sparade Petrel-projekt. Även om API:et är ett sätt att ladda upp data rekommenderar vi att du laddar upp dina projekt via DELFI Petrel Project Explorer. Alla följande API-anrop förutsätter att du har ett projekt uppladdat till Petrel Project Explorer.
Skapa en juridisk tagg
Skapa en juridisk tagg som automatiskt läggs till i din Petrel DDMS-miljö för dataefterlevnad.
API: Konfigurera>Skapa juridisk tagg för PDS
Metod: POST
Mer information finns i Hantera juridiska taggar.
Lägga till användare i en berättigandegrupp
För att användare ska ha rätt behörighet att göra Petrel DDMS API-anrop måste de vara en del av users.datalake.admins@{data-partition-id}.dataservices.energy berättigandegruppen. Det här anropet lägger till en användare i rätt grupp.
Användaren i det här fallet är klient-ID eller OID i den token som används för autentisering. Om du till exempel genererar en token med hjälp av 8cdxxxxxxxxxxxxett klient-ID för måste du lägga till 8cdxxxxxxxxxxxx i users.datalake.admins gruppen.
API: Konfigurera>Lägg till användare i DATALAKE-administratörer
Metod: POST
Hämta ett projekt
Använd ett projekt-ID för att returnera motsvarande Petrel-projektpost i din Azure Data Manager for Energy-instans.
API: Project>Get Project
Metod: GET
Ta bort projektet
Använd ett projekt-ID för att ta bort ett projekt och tillhörande Petrel-projektpostdata i din Azure Data Manager for Energy-instans.
API: Projektborttagningsprojekt>
Metod: DELETE
Hämta en projektversion
Använd ett projekt-ID och ett versions-ID för att hämta petrelversionsposten som är associerad med projektet och versionen i din Azure Data Manager for Energy-instans.
API: Project>Get Project Version
Metod: GET
Hämta en url för projektnedladdning
Använd ett projekt-ID för att hämta en SAS-URL (signatur för delad åtkomst) så att du kan ladda ned data för motsvarande projekt från din Azure Data Manager för Energy-instans.
API: Hämta>Project Project Download
Metod: GET
Hämta en url för projektuppladdning
Använd ett projekt-ID för att hämta två SAS-URL:er. En URL laddar upp data till motsvarande projekt i din Azure Data Manager for Energy-instans. Den andra URL:en laddar ned data från motsvarande projekt i din Azure Data Manager for Energy-instans.
API: Project Get Signed Upload URL (Hämta>signerad uppladdnings-URL)
Metod: POST
URL:en för SAS-uppladdning bör se ut ungefär så här:
https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}?{SAS-token-info}
Du kan ändra den här URL:en så att den innehåller filnamnet för data som du vill ladda upp:
https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}/{FILENAME}?{SAS-token-info}
När du PUT anropar den här URL:en laddas innehållet body i till bloblagringen under det angivna FILENAME värdet.
Uppdatera ett projekt
Använd ett projekt-ID och en SAS-uppladdnings-URL för att uppdatera en Petrel-projektpost i Azure Data Manager for Energy med de nya värdena. Du kan också ladda upp data till ett projekt om du vill.
API: Projektuppdateringsprojekt>
Metod: PUT
Sök igenom projekt
Du kan söka igenom Petrel-projekt med hjälp av många fält. Anropet returnerar alla matchande projekt-ID:er. API:et stöder:
- Fulltextsökning i strängfält.
- Intervallfrågor baserat på datum-, numeriska eller strängfält.
- Geospatial sökning.
API: Projektsökningsprojekt>
Metod: POST
Relaterat innehåll
Använd följande DELFI-länkar för att läsa andra självstudier som omfattar Petrel Project Explorer och Petrel-arbetsflöden: