Tutorial: Trabalhar com registros de dados de poço usando APIs DDMS de entrega de poço

Este tutorial demonstra como utilizar APIs DDMS (Well Delivery Domain Data Management Services) com cURL para gerenciar o registro de poço em uma instância do Azure Data Manager for Energy.

Neste tutorial, irá aprender a:

Para obter mais informações sobre DDMS, consulte Conceitos de DDMS.

Prerequisites

• Uma subscrição do Azure
• Uma instância do Azure Data Manager for Energy criada na sua subscrição do Azure
• Ferramenta de linha de comando cURL instalada na sua máquina
• Gere o token de acesso da service principal para chamar as Well Delivery APIs. Consulte Como gerar token de autenticação.

Obtenha os detalhes da instância do Azure Data Manager for Energy

Para continuar, reúna os seguintes detalhes da sua instância do Azure Data Manager for Energy através do portal do Azure:

Use APIs DDMS de entrega de poço para trabalhar com registros de dados de poço

Criar uma etiqueta legal

Crie uma tag legal para conformidade de dados.

Execute o seguinte cURL comando para criar uma marca legal:

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

Exemplo de resposta:

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

Para obter mais informações, consulte Gerenciar tags legais.

Adicionar usuários a um grupo de direitos

Para que os utilizadores tenham as permissões adequadas para fazer chamadas de API DDMS de Well Delivery, devem fazer parte dos grupos de direitos data.default.viewers@{data-partition-id}.dataservices.energy e data.default.owners@<data_partition_id>.dataservices.energy. Esta chamada adiciona um usuário ao grupo adequado.

Siga o guia Gerenciar usuários para adicionar direitos apropriados para o usuário.

Criar um registo de poço

Crie um registro de poço em sua instância do Azure Data Manager for 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"
    }
}'

Exemplo de resposta:

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

Criar um registo wellbore

Crie um registro wellbore em sua instância do 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"
    }
}'

Exemplo de resposta:

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

Criar um plano de atividades

Crie um plano de atividades.

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

Exemplo de resposta:

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

Próximos passos

Vá para o próximo tutorial para aprender a trabalhar com dados de poço usando APIs DDMS Wellbore:

Para obter mais informações sobre as APIs REST DDMS do Well Delivery no Azure Data Manager for Energy, consulte as especificações OpenAPI disponíveis no repositório do GitHub adme-samples .