Partilhar via


Usar o ponto de extremidade do OData com os recursos da Web

 

Publicado: novembro de 2016

Aplicável a: Dynamics CRM 2015

O ponto de extremidade do OData com recursos da Web fornece uma interface alternativa para trabalhar com os dados do Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015. É possível usar o ponto de extremidade do OData para executar as solicitações de HTTP usando um serviço baseado em um Identificador de Recurso Uniforme (URI).

Neste tópico

O que é o OData?

Implementação de OData do Microsoft Dynamics CRM

Ferramentas de terceiros para gerar o código

O que é o OData?

O ponto de extremidade do OData usa o protocolo Open Data. Este protocolo implementa um padrão de design “RESTful”. REST significa Transferência de Estado Representativo.REST é um estilo de arquitetura no qual cada recurso é tratado usando um URI exclusivo. No Microsoft Dynamics 365, um recurso pode ser um conjunto de entidades ou um registro.

O REST funciona de forma semelhante à Internet. Você interage com os recursos usando verbos de HTTP como GET, POST, MERGE e DELETE. Várias bibliotecas podem ser usadas para processar solicitações HTTP e respostas.REST fornece uma interface padrão que pode ser usada com qualquer linguagem de programação.REST permite o processamento síncrono ou assíncrono de operações. O recurso de execução de operações assíncronas torna o REST ideal para os scripts e recursos da Web usados no Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015.

Implementação de OData do Microsoft Dynamics CRM

Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015 O usa a estrutura dos Serviços de Dados do WCF (Windows Communication Foundation) para fornecer um ponto de extremidade do Protocolo Open Data (OData), que é um serviço de dados baseado no REST. Esse ponto de extremidade é chamado Organization Data Service. No Microsoft Dynamics 365, o URI raiz do serviço é:

[Your Organization Root URL]/xrmservices/2011/organizationdata.svc

OData envia e recebe dados usando ATOM ou JavaScript Object Notation (JSON).ATOM é um formato baseado em XML usado normalmente para feeds RSS.JSON é um formato de texto que permite a serialização de objetos JavaScript.

Para fornecer um conjunto consistente de URIs que correspondam às entidades usadas no Microsoft Dynamics 365, um Modelo de Dados da Entidade (EDM) organiza os dados na forma de registros dos “tipos de entidade” e as associações entre eles.

Modelo de Dados da Entidade do OData

O EDM do Microsoft Dynamics 365 é descrito em um documento de Metadados de Serviço do OData disponível no seguinte caminho:

[Your Organization Root URL]/xrmservices/2011/organizationdata.svc/$metadata

Este documento XML usa a linguagem de definição de esquema conceitual (CSDL) para descrever os dados disponíveis. Faça o download deste documento e use-o para gerar classes tipadas ao usar o código gerenciado ou como referência para objetos disponíveis ao usar o JavaScript.

Limitações

O ponto de extremidade do OData fornece uma alternativa ao ponto de extremidade do SOAP, mas atualmente há algumas limitações.

  • Somente ações de Criação, Recuperação, Atualização e Exclusão podem ser executadas nos registros da entidade.

    • As mensagens que exigem o método Execute não poderão ser executadas.

    • Ações de associação e desassociação podem ser executadas com as propriedades de navegação.

  • O protocolo OData não é totalmente implementado. Algumas opções de consulta do sistema não estão disponíveis.
    Para obter mais informações, consulte Opções de consulta do sistema OData usando o ponto de extremidade do OData.

  • Não é possível usar a associação tardia com o código gerenciado em entidades personalizadas, atributos ou relacionamentos que não existiam quando o código foi escrito.
    Geralmente, você usará as classes de Serviço de Dados do Cliente e de Serviços de Dados do WCF durante a programação com o código gerenciado. Estas classes permitem a associação inicial, para que sejam obtidas classes fortemente tipadas no momento da criação. As únicas entidades disponíveis são aquelas definidas no sistema quando as classes foram geradas. Isso significa que não é possível usar a associação tardia para trabalhar com entidades personalizadas, atributos ou relacionamentos que não foram incluídos nas classes de Serviço de Dados do Cliente e de Serviços de Dados do WCF quando elas foram geradas.

Ferramentas de terceiros para gerar o código

A comunidade de desenvolvedores que trabalha com o Microsoft Dynamics 365 criou algumas ferramentas que demonstram como o ponto de extremidade do OData funciona e pode gerar o código que você pode usar. As ferramentas a seguir fornecem capacidades de gerar o código que funciona com os dados do Dynamics 365 usando o ponto de extremidade do OData.

  • REST Builder do CMR
    Use esta ferramenta para criar solicitações para recuperar dados e executar operações usando uma variedade de bibliotecas do JavaScript.

    Agradecimentos ao MVP do Microsoft Dynamics 365Jason Lattimer por criar esta ferramenta.

  • Criador de consultas OData
    Incluído no projeto Dynamics XRM Tools, o Query Design do OData permite a criação de consultas para recuperar dados usando o ponto de extremidade do OData.

    Agradecimentos ao MVP do Microsoft Dynamics 365Rhett Clinton por ciar este e outras ferramentas.

Confira Também

Use dados do serviço Web nos recursos da Web (OData e ponto de extremidade SOAP do aplicativo ENSABOAM)
Usar o ponto de extremidade Modern App do SOAP para aplicativos modernos com os recursos da Web
Recursos da Web do Microsoft Dynamics CRM 2015
Baixar os pontos de extremidade usando a página de recursos do Desenvolvedor do Microsoft Dynamics CRM 2015
Consultar dados do Microsoft Dynamics CRM 2015 usando o ponto de extremidade OData
Executar operações de dados básicas usando o ponto de extremidade OData
Usar o ponto de extremidade do OData com os recursos da Web JScript e Ajax
Executar operações de dados adicionais usando o ponto de extremidade OData
Exemplo: Criar, recuperar, atualizar e excluir usando o ponto de extremidade OData com o JavaScript e jQuery
Exemplo: Criar, recuperar, atualizar e excluir usando o ponto de extremidade OData com JavaScript
Amostra: Editor de contato jQuery do ponto de extremidade OData
Visão geral do protocolo Open Data
SDK do OData
Artigo técnico: Using Option Set Options with the REST Endpoint - JScript

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais