Compartir a través de

Tutorial: Uso de registros de datos correctos mediante las API de DDMS de Well Delivery

En este tutorial se muestra cómo utilizar las API de Well Delivery Domain Data Management Services (DDMS) con cURL para gestionar los registros de pozos dentro de una instancia de Azure Data Manager for Energy.

En este tutorial, aprenderá a:

  • Utilizar las API de DDMS de Well Delivery para trabajar con registros de datos de Well.

Para más información sobre DDMS, consulte Conceptos de DDMS.

Prerequisites

Obtener los detalles de la instancia de Azure Data Manager for Energy

Para continuar, recopile los detalles siguientes de la instancia de Azure Data Manager for Energy a través de Azure Portal:

Parameter Descripción Example Dónde encontrar este valor
client_id Id. de aplicación (cliente) 00001111-aaaa-2222-bbbb-3333cccc4444 Este id. de cliente o aplicación se usa al registrar la aplicación con la plataforma de identidad de Microsoft. Consulte Registro de una aplicación.
client_secret Secreto del cliente _fl****************** El secreto de cliente, a veces denominado contraseña de aplicación, es un valor de cadena que la aplicación puede usar en lugar de un certificado a fin de identificarse. Consulte Agregar un secreto de cliente.
tenant_id Id. de directorio (inquilino) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx Mantenga el puntero sobre el nombre de la cuenta en Azure Portal para obtener el directorio o el id. de inquilino. Como alternativa, busque y seleccione Microsoft Entra ID>Propiedades>ID de inquilino en el portal de Azure.
base_url Dirección URL de la instancia https://<instance>.energy.azure.com Busca este valor en la página de información general de la instancia de Azure Data Manager for Energy.
data_partition_id Nombre de la partición de datos opendes Busca este valor en la página de información general de la instancia de Azure Data Manager for Energy.
access_token Valor del token de acceso 0.ATcA01-XWHdJ0ES-qDevC6r........... Siga Cómo generar el token de autenticación para crear un token de acceso y guardarlo.

Utilizar las API de DDMS de Well Delivery para trabajar con registros de datos de Well

Cree una etiqueta legal para el cumplimiento de normativas de datos.

Ejecute el comando siguiente cURL para crear una etiqueta 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"
           }
       }'

Respuesta de ejemplo:

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

Para obtener más información, consulte Administración de etiquetas legales.

Agregar usuarios a un grupo de derechos

Para que los usuarios tengan los permisos adecuados para realizar llamadas API de DDMS de Well Delivery, deben ser parte de los grupos de permisos data.default.viewers@{data-partition-id}.dataservices.energy y data.default.owners@<data_partition_id>.dataservices.energy. Esta llamada agrega un usuario al grupo adecuado.

Siga la guía Administrar usuarios para agregar los derechos adecuados para el usuario.

Creación de un registro de pozo

Cree un registro de los pozos en la instancia de 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"
    }
}'

Respuesta de ejemplo:

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

Creación de un registro de wellbore

Cree un registro de wellbore en la instancia de 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"
    }
}'

Respuesta de ejemplo:

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

Creación de un grupo de actividad

Creación de un grupo de actividad.


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

Respuesta de ejemplo:

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

Pasos siguientes

Vaya al siguiente tutorial para aprender a trabajar con datos de well mediante las API de DDMS de Wellbore:

Tutorial: Uso de registros de datos de well mediante las API de Wellbore DDMS

Para más información sobre las API REST de Well Delivery DDMS en Azure Data Manager for Energy, consulte las especificaciones de OpenAPI disponibles en el repositorio de GitHub adme-samples .

  • Last updated on