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

Use APIs DDMS (Well Delivery Domain Data Management Services) no Postman para trabalhar com dados de poço em sua instância do Azure Data Manager for Energy.

Neste tutorial, irá aprender a:

  • Configure o Carteiro para usar uma coleção DDMS de Entrega de Poços.
  • Configure o Postman para usar um ambiente DDMS de Entrega de Poços.
  • Envie pedidos via Carteiro.
  • Gere um token de autorização.
  • Use APIs DDMS de entrega de poço para trabalhar com registros de dados de poço.

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

Pré-requisitos

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

A primeira etapa é obter as seguintes informações da sua instância do Azure Data Manager for Energy no portal do Azure:

Parâmetro Valor Exemplo
CLIENT_ID ID da aplicação (cliente) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
CLIENT_SECRET Segredos de cliente _fl******************
TENANT_ID ID do Diretório (inquilino) 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx
SCOPE ID da aplicação (cliente) 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx
base_uri URI <instance>.energy.azure.com
data-partition-id Partições de dados <instance>-<data-partition-name>

Você usará essas informações mais adiante no tutorial.

Configurar o Postman

  1. Transfira e instale a aplicação de ambiente de trabalho Postman .

  2. Importe os seguintes arquivos no Postman:

    Para importar os ficheiros:

    1. Crie dois arquivos JSON em seu computador copiando os dados que estão nos arquivos de coleção e ambiente.

    2. No Postman, selecione Importar>arquivos Escolher arquivos e, em seguida, selecione os dois arquivos> JSON no seu computador.

    3. Em Importar Entidades no Postman, selecione Importar.

      Screenshot that shows importing collection and environment files in Postman.

  3. No ambiente do Postman, atualize VALOR ATUAL com as informações do seu Azure Data Manager for Energy por exemplo:

    1. No Postman, no menu à esquerda, selecione Ambientes e, em seguida, selecione Ambiente WellDelivery.

    2. Na coluna VALOR ATUAL, insira as informações da tabela na seção Obter seus detalhes da instância do Azure Data Manager for Energy deste tutorial.

    Screenshot that shows where to enter current values in the Well Delivery DDMS environment.

Enviar um pedido de carteiro

A coleção Postman para DDMS de Entrega de Poços contém solicitações que você pode usar para interagir com dados sobre poços, poços, logs de poços e trajetória de poços em seu Gerenciador de Dados do Azure para Energia, por exemplo.

Para obter um exemplo de como enviar uma solicitação de carteiro, consulte o tutorial Wellbore DDMS.

Gerar um token para APIs

Gere um token que você pode usar para trabalhar com APIs DDMS do Well Delivery:

  1. Importe o seguinte comando cURL no Postman para gerar um token de portador. Use os valores da sua instância do Azure Data Manager for Energy.

     curl --location --request POST 'https://login.microsoftonline.com/{{TENANT_ID}}/oauth2/v2.0/token' \
         --header 'Content-Type: application/x-www-form-urlencoded' \
         --data-urlencode 'grant_type=client_credentials' \
         --data-urlencode 'client_id={{CLIENT_ID}}' \
         --data-urlencode 'client_secret={{CLIENT_SECRET}}' \
         --data-urlencode 'scope={{SCOPE}}'  
    

    Screenshot of cURL code in a Well Delivery DDMS token.

  2. Use a saída de token para atualizar access_token em seu ambiente DDMS de entrega de poços. Em seguida, você pode usar o token de portador como um tipo de autorização em outras chamadas de API.

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

A conclusão bem-sucedida das solicitações do Postman descritas nas APIs DDMS de Entrega de Poço a seguir indica ingestão e recuperação bem-sucedidas de registros de poço em sua instância do Azure Data Manager for Energy.

Criar um registo de poço

Crie um registro de poço em sua instância do Azure Data Manager for Energy.

API: UC1>entity_create bem

Método: PUT

Screenshot that shows the API that creates a well record.

Criar um registo wellbore

Crie um registro wellbore em sua instância do Azure Data Manager for Energy.

API: UC1>entity_create poço

Método: PUT

Screenshot that shows the API that creates a wellbore record.

Obtenha uma versão bem

Obtenha um registro de poço com base em um ID de poço específico.

API: UC1>entity_create bem Copiar

Método: GET

Screenshot that shows the API that gets a well record based on a specific well ID.

Criar um plano de atividades

Crie um plano de atividades.

API: UC1>entity_create plano de atividades

Método: PUT

Screenshot that shows the API that creates an activity plan.

Obtenha um plano de atividades por ID do poço

Obtenha o objeto do plano de atividades para um ID de poço específico.

API: UC2>activity_plans_by_well

Método: GET

Screenshot of the API that gets an activity plan by well ID.

Excluir um registro wellbore

Você pode excluir um registro wellbore em sua instância do Azure Data Manager for Energy usando APIs DDMS de Entrega de Poços. A captura de tela a seguir mostra um exemplo.

Screenshot that shows how to use an API to delete a wellbore record.

Excluir um registro de poço

Você pode excluir um registro de poço em sua instância do Azure Data Manager for Energy usando APIs DDMS de Entrega de Poços. A captura de tela a seguir mostra um exemplo.

Screenshot that shows how to use an API to delete a well record.

Próximos passos

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