Tutorial: Trabalhar com registros de dados Petrel usando APIs DDMS Petrel

Artigo
02/02/2024

Use as APIs do Petrel Domain Data Management Services (DDMS) no Postman para trabalhar com dados Petrel em sua instância do Azure Data Manager for Energy.

Neste tutorial, irá aprender a:

Configure o Postman para usar uma coleção Petrel DDMS.
Configure o Postman para usar um ambiente Petrel DDMS.
Envie pedidos via Carteiro.
Gere um token de autorização.
Use as APIs DDMS do Petrel para trabalhar com registros de dados e projetos Petrel.

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

Pré-requisitos

Uma subscrição do Azure
Uma instância do Azure Data Manager for Energy criada na sua subscrição do Azure

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)	`3dfxxxxxxxxxxxxxxxxxxxxxx`
`CLIENT_SECRET`	Segredos de cliente	`_fl******************`
`TENANT_ID`	ID do Diretório (inquilino)	`72fxxxxxxxxxxxx`
`SCOPE`	ID da aplicação (cliente)	`3dfxxxxxxxxxxxxxxxxxxxxxxx`
`HOSTNAME`	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

Transfira e instale a aplicação de ambiente de trabalho Postman .
Importe o seguinte arquivo no Postman: Petrel DDMS Postman collection.
Crie um ambiente Postman usando os valores obtidos anteriormente. O ambiente deve ser semelhante a este exemplo:

Gerar um token para usar em APIs

A coleção Postman para Petrel DDMS contém solicitações que você pode usar para interagir com seus projetos Petrel. Ele também contém uma solicitação para consultar projetos e registros atuais do Petrel em sua instância do Azure Data Manager for Energy.

Em Postman, no menu à esquerda, selecione Coleções e, em seguida, selecione Petrel DDMS. Em Configuração, selecione Obter Token.
Na lista suspensa Ambiente no canto superior direito, selecione Ambiente DDMS Petrel.
Para enviar a solicitação, selecione Enviar.

Essa solicitação gera um token de acesso e o atribui como o método de autorização para solicitações futuras.

Você também pode gerar um token usando o comando cURL no Postman ou um terminal 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}}'

Para usar esse token gerado por cURL, você deve atualizar access_token suas Collection variáveis com o valor after Bearer na resposta.

Usar APIs DDMS Petrel para trabalhar com projetos Petrel

A conclusão bem-sucedida das solicitações do Postman descritas nas APIs DDMS do Petrel a seguir indica uma interação bem-sucedida com seus projetos Petrel salvos. Embora a API forneça uma maneira de carregar dados, recomendamos que você carregue seus projetos via DELFI Petrel Project Explorer. Todas as chamadas de API a seguir pressupõem que você tenha um projeto carregado no Petrel Project Explorer.

Criar uma etiqueta legal

Crie uma tag legal que é adicionada automaticamente ao seu ambiente Petrel DDMS para conformidade de dados.

API: Configuração>Criar marca legal para PDS

Método: POST

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

Adicionar usuários a um grupo de direitos

Para que os usuários tenham as permissões adequadas para fazer chamadas de API DDMS Petrel, eles devem fazer parte do users.datalake.admins@{data-partition-id}.dataservices.energy grupo de direitos. Esta chamada adiciona um usuário ao grupo adequado.

O usuário, neste caso, é o ID do cliente ou OID no token usado para autenticação. Por exemplo, se você gerar um token usando uma ID de cliente de 8cdxxxxxxxxxxxx, deverá adicionar 8cdxxxxxxxxxxxx ao users.datalake.admins grupo.

API: Configuração>Adicionar usuário aos administradores do DATALAKE

Método: POST

Obter um projeto

Use uma ID de projeto para retornar o registro de projeto Petrel correspondente em sua instância do Azure Data Manager for Energy.

API: Project Get Project>

Método: GET

Eliminar um projeto

Use uma ID de projeto para excluir um projeto e os dados de registro de projeto Petrel associados em sua instância do Azure Data Manager for Energy.

API: Projeto Excluir Projeto>

Método: DELETE

Obter uma versão do projeto

Use uma ID de projeto e uma ID de versão para obter o registro de versão Petrel associado ao projeto e à versão em sua instância do Azure Data Manager for Energy.

API: Project>Get Project Version

Método: GET

Obter um URL de download do projeto

Use uma ID de projeto para obter uma URL de assinatura de acesso compartilhado (SAS) para que você possa baixar os dados do projeto correspondente de sua instância do Azure Data Manager for Energy.

API: Project Get Project>Download

Método: GET

Obter um URL de carregamento de projeto

Use um ID de projeto para obter duas URLs SAS. Uma URL carrega dados para o projeto correspondente em sua instância do Azure Data Manager for Energy. A outra URL baixa dados do projeto correspondente em sua instância do Azure Data Manager for Energy.

API: URL de carregamento assinado do Project>Get Signed

Método: POST

O URL de carregamento do SAS deve ser semelhante a este exemplo:

https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}?{SAS-token-info}

Pode modificar este URL para conter o nome de ficheiro dos dados que pretende carregar:

https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}/{FILENAME}?{SAS-token-info}

Fazer uma PUT chamada para este URL carrega o conteúdo do para o armazenamento de body blob sob o valor fornecido FILENAME .

Atualizar um projeto

Use uma ID de projeto e uma URL de carregamento SAS para atualizar um registro de projeto Petrel no Azure Data Manager for Energy com os novos valores. Você também pode carregar dados para um projeto, se desejar.

API: Projeto de atualização do projeto>

Método: PUT

Pesquisar através de projetos

Você pode pesquisar através de projetos Petrel usando muitos campos. A chamada retorna todas as IDs de projeto correspondentes. A API suporta:

Pesquisa de texto completo em campos de cadeia de caracteres.
Consultas de intervalo com base em campos de data, numéricos ou cadeia de caracteres.
Pesquisa geoespacial.

API: Projetos de Pesquisa de Projetos>

Método: POST

Use os seguintes links DELFI para ler outros tutoriais que envolvem os fluxos de trabalho Petrel Project Explorer e Petrel:

Partilhar via

Tutorial: Trabalhar com registros de dados Petrel usando APIs DDMS Petrel

Pré-requisitos

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

Configurar o Postman

Gerar um token para usar em APIs