Partager via

Tutoriel : Utiliser des enregistrements de données bien à l’aide des API DDMS Well Delivery

Ce tutoriel démontre comment utiliser les API des Services de Gestion de Données du Domaine de Livraison de Puits (DDMS) avec cURL pour gérer un enregistrement de puits dans une instance d'Azure Data Manager for Energy.

Dans ce tutoriel, vous allez apprendre à :

  • Utilisez les API DDMS Well Delivery pour travailler avec des enregistrements de données.

Pour plus d’informations sur DDMS, consultez Concepts DDMS.

Prerequisites

Obtenir les détails concernant votre instance Azure Data Manager for Energy

Pour continuer, rassemblez les détails suivants à partir de votre instance Azure Data Manager for Energy via le portail Azure :

Parameter Descriptif Example Où trouver cette valeur
client_id ID d’application (client) 00001111-aaaa-2222-bbbb-3333cccc4444 Vous utilisez cette application ou cet ID client lors de l’inscription de l’application auprès de la plateforme d’identités Microsoft. Voir Inscrire une application
client_secret Clé secrète client _fl****************** Parfois appelé mot de passe d’application, une clé secrète client est une valeur de chaîne que votre application peut utiliser à la place d’un certificat pour l’identité elle-même. Consultez Ajouter un secret client.
tenant_id ID de l’annuaire (locataire) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx Placez le curseur sur le nom de votre compte dans le portail Azure pour obtenir l’ID d’annuaire ou de locataire. Vous pouvez également rechercher et sélectionner Microsoft Entra ID>Propriétés>ID de locataire dans le portail Azure.
base_url URL d’instance https://<instance>.energy.azure.com Recherchez cette valeur dans la page vue d’ensemble de l’instance Azure Data Manager for Energy.
data_partition_id Nom de la partition de données opendes Recherchez cette valeur dans la page vue d’ensemble de l’instance Azure Data Manager for Energy.
access_token Valeur du jeton d’accès 0.ATcA01-XWHdJ0ES-qDevC6r........... Suivez comment générer un jeton d’authentification pour créer un jeton d’accès et l’enregistrer.

Utilisez les API DDMS Well Delivery pour travailler avec des enregistrements de données

Créez une balise légale pour la conformité des données.

Exécutez la commande suivante cURL pour créer une balise légale :

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"
           }
       }'

Exemple de réponse :

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

Pour plus d’informations, consultez Gérer les balises légales.

Ajouter des utilisateurs à un groupe de droits d’utilisation

Pour que les utilisateurs disposent des autorisations appropriées pour effectuer des appels d’API DDMS Well Delivery, ils doivent faire partie des groupes d'attribution de droits data.default.viewers@{data-partition-id}.dataservices.energy et data.default.owners@<data_partition_id>.dataservices.energy. Cet appel ajoute un utilisateur au groupe approprié.

Suivez le guide Gérer les utilisateurs pour ajouter les droits appropriés pour l’utilisateur.

Créer un enregistrement de puits

Créez un enregistrement de puits dans votre instance Azure Data Manager pour Energy.

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"
    }
}'

Exemple de réponse :

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

Créez un enregistrement de puits de forage

Créez un enregistrement de puits de forage dans votre instance Azure Data Manager for Energy.

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"
    }
}'

Exemple de réponse :

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

Créer un plan d'activité

Créez un plan d'activité.


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"
    }
}'

Exemple de réponse :

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

Étapes suivantes

Consultez le tutoriel suivant pour découvrir comment utiliser les données de puits à l’aide des API Wellbore DDMS :

Tutoriel : Utiliser des enregistrements de données Well à l’aide des API DDMS Wellbore

Pour plus d’informations sur les API REST Well Delivery DDMS dans Azure Data Manager for Energy, consultez les spécifications OpenAPI disponibles dans le référentiel GitHub adme-samples .

  • Last updated on