Zelfstudie: Werken met brongegevensrecords met behulp van Well Delivery DDMS-API's

Deze zelfstudie laat zien hoe u Well Delivery Domain Data Management Services (DDMS)-API's gebruikt met cURL voor het beheren van goede records binnen een Exemplaar van Azure Data Manager for Energy.

In deze zelfstudie leert u het volgende:

Zie DDMS-concepten voor meer informatie over DDMS.

Prerequisites

• Een Azure-abonnement
• Een exemplaar van Azure Data Manager for Energy dat is gemaakt in uw Azure-abonnement
• cURL-opdrachtregelprogramma geïnstalleerd op uw computer
• Genereer het toegangstoken voor de service-principal om de Well Delivery-API's aan te roepen. Zie Hoe u een verificatietoken genereert.

De details van uw Azure Data Manager for Energy-exemplaar ophalen

Als u wilt doorgaan, verzamelt u de volgende gegevens van uw Azure Data Manager for Energy-exemplaar via Azure Portal:

Well Delivery DDMS-API's gebruiken om te werken met brongegevensrecords

Een juridische tag maken

Maak een juridische tag voor gegevensnaleving.

Voer de volgende cURL opdracht uit om een juridische tag te maken:

curl -X POST "https://{base_url}/api/legal/v1/legaltags" \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -H "data-partition-id: <data_partition_id>" \
     -d '{
           "name": "LegalTagName",
           "description": "Legal Tag added for Well",
           "properties": {
               "contractId": "123456",
               "countryOfOrigin": ["US", "CA"],
               "dataType": "Third Party Data",
               "exportClassification": "EAR99",
               "originator": "xyz",
               "personalData": "No Personal Data",
               "securityClassification": "Private",
               "expirationDate": "2025-12-25"
           }
       }'

Voorbeeldantwoord:

{
  "name": "LegalTagName",
  "status": "Created"
}

Zie Juridische tags beheren voor meer informatie.

Gebruikers toevoegen aan een toegangsrechten-groep

Voor gebruikers die over de juiste machtigingen beschikken om Well Delivery DDMS API-aanroepen uit te voeren, moeten ze deel uitmaken van de data.default.viewers@{data-partition-id}.dataservices.energy en data.default.owners@<data_partition_id>.dataservices.energy rechtengroepen. Met deze aanroep wordt een gebruiker toegevoegd aan de juiste groep.

Volg de handleiding Gebruikers beheren om de juiste rechten voor de gebruiker toe te voegen.

Een bronrecord maken

Maak een bronrecord in uw Azure Data Manager for Energy-exemplaar.

curl --request PUT \
  --url https://{base_url}/api/well-delivery/storage/v1/well \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --header 'data-partition-id: <data_partition_id>' \
  --data '{
    "id":"<data_partition_id>:master-data--Well:well-1753861267 434",
    "kind": "osdu:wks:master-data--Well:1.0.0",
    "acl": {
        "viewers": [
            "data.default.viewers@<data_partition_id>.dataservices.energy"
        ],
        "owners": [
            "data.default.owners@<data_partition_id>.dataservices.energy"
        ]
    },
    "legal": {
        "legaltags": [
            "LegalTagName"
        ],
        "otherRelevantDataCountries": [
            "US"
        ]
    },
    "data": {
        "ExistenceKind": "namespace:reference-data--ExistenceKind:planned:",
        "FacilityName": "Well-Test"
    }
}'

Voorbeeldantwoord:

{
"created entity": "well-1753861267434:1753861269454"
}

Een wellbore-record maken

Maak een bronrecord in uw Azure Data Manager for Energy-exemplaar.

curl --request PUT \
  --url https://{base_url}/api/well-delivery/storage/v1/  wellbore \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --header 'data-partition-id: <data_partition_id>' \
  --data '{
    "id": "dp1:master-data--Wellbore:wellbore-1753861298505",
    "kind": "osdu:wks:master-data--Wellbore:1.0.0",
    "acl": {
        "viewers": [
            "data.default.viewers@<data_partition_id>.dataservices.energy"
        ],
        "owners": [
            "data.default.owners@<data_partition_id>.dataservices.energy"
        ]
    },
    "legal": {
        "legaltags": [
            "LegalTagName"
        ],
        "otherRelevantDataCountries": [
            "US"
        ]
    },
    "data": {
        "ExistenceKind": "namespace:reference-data--ExistenceKind:planned:",
        "WellID": "<data_partition_id>:master-data--Well:well-1753861298505:1753861300000",
        "Name": "Demo wellbore name"
    }
}'

Voorbeeldantwoord:

{
"created entity": "wellbore-1753861298505:1753861301020"
}

Een activiteitenplan maken

Maak een activiteitenplan.

curl --request PUT \
  --url https://{base_url}/api/well-delivery/storage/v1/activityplan \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --header 'data-partition-id: <data_partition_id>' \
  --data '{
    "id": "dp1:master-data--ActivityPlan:activityplan-1753861290577",
    "kind": "osdu:wks:master-data--ActivityPlan:1.0.0",
    "acl": {
        "viewers": [
            "data.default.viewers@<data_partition_id>.dataservices.energy"
        ],
        "owners": [
            "data.default.owners@<data_partition_id>.dataservices.energy"
        ]
    },
    "legal": {
        "legaltags": [
            "LegalTagName"
        ],
        "otherRelevantDataCountries": [
            "US"
        ]
    },
    "data": {
        "ExistenceKind": "namespace:reference-data--ExistenceKind:planned:",
        "WellboreID": "<data_partition_id>:master-data--Wellbore:wellbore-1753861290577:1753861293139"
    }
}'

Voorbeeldantwoord:

{
"created entity" : "activityplan-1753861290577:1753861294109"
}

Volgende stappen

Ga naar de volgende zelfstudie voor meer informatie over het werken met brongegevens met behulp van Wellbore DDMS-API's:

Zie de OpenAPI-specificaties die beschikbaar zijn in de GitHub-opslagplaats adme-samples voor meer informatie over de Well Delivery DDMS REST API's in Azure Data Manager for Energy.