Руководство. Работа с хорошо записями данных с помощью API-интерфейсов DDMS для доставки

В этом руководстве показано, как использовать API службы управления данными Well Delivery Domain (DDMS) с помощью cURL для управления данными скважины в экземпляре Azure Data Manager for Energy.

В этом руководстве описано следующее:

Дополнительные сведения о DDMS см . в концепциях DDMS.

Prerequisites

• Подписка Azure
• Экземпляр Azure Data Manager для энергетики , созданный в подписке Azure
• Средство командной строки cURL, установленное на компьютере
• Создайте токен доступа служебного пользователя для вызова API-интерфейсов Well Delivery. Узнайте, как создать токен проверки подлинности.

Получение сведений об экземпляре Azure Data Manager для энергетики

Чтобы продолжить, соберите следующие сведения из экземпляра Azure Data Manager для энергетики с помощью портала Azure:

Использование API-интерфейсов DDMS для хорошой доставки данных

Создание юридического тега

Создайте юридический тег для соответствия данным.

Выполните следующую cURL команду, чтобы создать юридический тег:

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

Пример ответа:

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

Дополнительные сведения см. в разделе "Управление юридическими тегами".

Добавление пользователей в группу полномочий

Чтобы пользователи имели надлежащие разрешения на вызовы API Well Delivery DDMS, они должны состоять в группах data.default.viewers@{data-partition-id}.dataservices.energy и data.default.owners@<data_partition_id>.dataservices.energy прав доступа. Этот вызов добавляет пользователя в соответствующую группу.

Следуйте руководству по управлению пользователями , чтобы добавить соответствующие права для пользователя.

Создание хорошой записи

Создайте запись в экземпляре Azure Data Manager для энергетики.

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

Пример ответа:

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

Создание записи wellbore

Создайтезаписьную запись в экземпляре Azure Data Manager для энергетики.

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

Пример ответа:

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

Создание плана действий

Создайте план действий.

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

Пример ответа:

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

Дальнейшие шаги

Перейдите к следующему руководству, чтобы узнать, как работать с хорошо данными с помощью API Wellbore DDMS:

Для получения дополнительной информации о REST API DDMS Well Delivery в Azure Data Manager для энергетики см. спецификации OpenAPI, доступные в репозитории GitHub adme-samples.